Package org.apache.juneau.rest.beans

Class SeeOtherRoot

java.lang.Object

org.apache.juneau.http.response.BasicHttpResponse

org.apache.juneau.http.response.SeeOther

org.apache.juneau.rest.beans.SeeOtherRoot

All Implemented Interfaces:

HttpMessage, HttpResponse

@Response
@Schema(description="Redirect to servlet root")
public class SeeOtherRoot
extends SeeOther

Convenience subclass of SeeOther for redirecting a response to the servlet root.

See Also:

• Utility Beans

Field Summary

Fields

Modifier and Type	Field	Description
static final SeeOtherRoot	INSTANCE	Reusable instance.

Fields inherited from class org.apache.juneau.http.response.SeeOther

REASON_PHRASE, STATUS_CODE

Constructor Summary

Constructors

Constructor	Description
SeeOtherRoot()	Constructor.
SeeOtherRoot(String content)	Constructor with no redirect.
SeeOtherRoot(SeeOtherRoot copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
SeeOtherRoot	copy()	Creates a builder for this class initialized with the contents of this bean.
SeeOtherRoot	setContent(String value)	Sets the body on this response.
SeeOtherRoot	setContent(HttpEntity value)	Sets the body on this response.
SeeOtherRoot	setHeader2(String name, String value)	Sets the specified header to the end of the headers in this builder.
SeeOtherRoot	setHeader2(Header value)	Sets the specified header to the end of the headers in this builder.
SeeOtherRoot	setHeaders(List<Header> values)	Sets the specified headers to the end of the headers in this builder.
SeeOtherRoot	setHeaders(HeaderList value)	Sets the specified headers on this response.
SeeOtherRoot	setHeaders2(Header... values)	Sets the specified headers to the end of the headers in this builder.
SeeOtherRoot	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
SeeOtherRoot	setLocation(String value)	Specifies the value for the Location header.
SeeOtherRoot	setLocation(URI value)	Specifies the value for the Location header.
SeeOtherRoot	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
SeeOtherRoot	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
SeeOtherRoot	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
SeeOtherRoot	setStatusCode2(int value)	Sets the status code on the status line.
SeeOtherRoot	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
SeeOtherRoot	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

Methods inherited from class org.apache.juneau.http.response.BasicHttpResponse

addHeader, addHeader, assertModifiable, assertStatusCode, containsHeader, getAllHeaders, getEntity, getFirstHeader, getHeaders, getHeaders, getLastHeader, getLocale, getParams, getProtocolVersion, getStatusLine, headerIterator, headerIterator, isUnmodifiable, removeHeader, removeHeaders, setEntity, setHeader, setHeader, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

INSTANCE

public static final SeeOtherRoot INSTANCE

Reusable instance.

Constructor Details

SeeOtherRoot

public SeeOtherRoot()

Constructor.

SeeOtherRoot

public SeeOtherRoot(SeeOtherRoot copyFrom)

Copy constructor.

Parameters:

copyFrom - The object to copy.

SeeOtherRoot

public SeeOtherRoot(String content)

Constructor with no redirect.

Used for end-to-end interfaces.

Parameters:

content - Message to send as the response.

Method Details

copy

public SeeOtherRoot copy()

Description copied from class: SeeOther

Creates a builder for this class initialized with the contents of this bean.

Overrides:

copy in class SeeOther

Returns:

A new builder bean.

setContent

public SeeOtherRoot setContent(HttpEntity value)

Description copied from class: BasicHttpResponse

Sets the body on this response.

Overrides:

setContent in class SeeOther

Parameters:

value - The body on this response.

Returns:

This object.

setContent

public SeeOtherRoot setContent(String value)

Description copied from class: BasicHttpResponse

Sets the body on this response.

Overrides:

setContent in class SeeOther

Parameters:

value - The body on this response.

Returns:

This object.

setHeader2

public SeeOtherRoot setHeader2(Header value)

Description copied from class: BasicHttpResponse

Sets the specified header to the end of the headers in this builder.

Overrides:

setHeader2 in class SeeOther

Parameters:

value - The header to add. null values are ignored.

Returns:

This object.

setHeader2

public SeeOtherRoot setHeader2(String name,
 String value)

Description copied from class: BasicHttpResponse

Sets the specified header to the end of the headers in this builder.

Overrides:

setHeader2 in class SeeOther

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public SeeOtherRoot setHeaders(HeaderList value)

Description copied from class: BasicHttpResponse

Sets the specified headers on this response.

Overrides:

setHeaders in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setHeaders

public SeeOtherRoot setHeaders(List<Header> values)

Description copied from class: BasicHttpResponse

Sets the specified headers to the end of the headers in this builder.

Overrides:

setHeaders in class SeeOther

Parameters:

values - The headers to add. null values are ignored.

Returns:

This object.

setHeaders2

public SeeOtherRoot setHeaders2(Header... values)

Description copied from class: BasicHttpResponse

Sets the specified headers to the end of the headers in this builder.

Overrides:

setHeaders2 in class SeeOther

Parameters:

values - The headers to add. null values are ignored.

Returns:

This object.

setLocale2

public SeeOtherRoot setLocale2(Locale value)

Description copied from class: BasicHttpResponse

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

Overrides:

setLocale2 in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setLocation

public SeeOtherRoot setLocation(String value)

Description copied from class: BasicHttpResponse

Specifies the value for the Location header.

Overrides:

setLocation in class SeeOther

Parameters:

value - The new header location.

Returns:

This object.

setLocation

public SeeOtherRoot setLocation(URI value)

Description copied from class: BasicHttpResponse

Specifies the value for the Location header.

Overrides:

setLocation in class SeeOther

Parameters:

value - The new header location.

Returns:

This object.

setProtocolVersion

public SeeOtherRoot setProtocolVersion(ProtocolVersion value)

Description copied from class: BasicHttpResponse

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setProtocolVersion in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setReasonPhrase2

public SeeOtherRoot setReasonPhrase2(String value)

Description copied from class: BasicHttpResponse

Sets the reason phrase on the status line.

If not specified, the reason phrase will be retrieved from the reason phrase catalog using the locale on this builder.

Overrides:

setReasonPhrase2 in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setReasonPhraseCatalog

public SeeOtherRoot setReasonPhraseCatalog(ReasonPhraseCatalog value)

Description copied from class: BasicHttpResponse

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Overrides:

setReasonPhraseCatalog in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setStatusCode2

public SeeOtherRoot setStatusCode2(int value)

Description copied from class: BasicHttpResponse

Sets the status code on the status line.

If not specified, 0 will be used.

Overrides:

setStatusCode2 in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setStatusLine

public SeeOtherRoot setStatusLine(BasicStatusLine value)

Description copied from class: BasicHttpResponse

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setStatusLine in class SeeOther

Parameters:

value - The new value.

Returns:

This object.

setUnmodifiable

public SeeOtherRoot setUnmodifiable()

Description copied from class: BasicHttpResponse

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class SeeOther

Returns:

This object.