org.apache.juneau.rest

Class Redirect

java.lang.Object

org.apache.juneau.rest.Redirect

public final class Redirect
extends Object

REST methods can return this object as a shortcut for performing HTTP 302 redirects.

See Also:

• Overview > juneau-rest-server > Redirect

Constructor Summary

Constructors

Constructor and Description
Redirect() Shortcut for redirecting to the servlet root.
Redirect(int httpResponseCode, Object url, Object... args) Redirect to the specified URL.
Redirect(Object uri) Convenience method for redirecting to instance of URL and URI.
Redirect(Object uri, Object... args) Redirect to the specified URL.

Method Summary

Modifier and Type	Method and Description
int	getHttpResponseCode() Returns the response code passed in through the constructor.
URI	getURI() Returns the URI to redirect to.

Methods inherited from class java.lang.Object

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

Constructor Detail

Redirect

public Redirect(Object uri,
                Object... args)

Redirect to the specified URL.

Relative paths are interpreted as relative to the servlet path.

Parameters:

uri - The URL to redirect to.
Can be any of the following:

• URL
• URI
• CharSequence

args - Optional MessageFormat-style arguments.

Redirect

public Redirect(Object uri)

Convenience method for redirecting to instance of URL and URI.

Same as calling toString() on the object and using the other constructor.

Parameters:

uri - The URL to redirect to.
Can be any of the following:

• URL
• URI
• CharSequence

Redirect

public Redirect(int httpResponseCode,
                Object url,
                Object... args)

Redirect to the specified URL.

Relative paths are interpreted as relative to the servlet path.

Parameters:

httpResponseCode - The HTTP response code.

url - The URL to redirect to.
Can be any of the following:

• URL
• URI
• CharSequence

args - Optional MessageFormat-style arguments.

Redirect

public Redirect()

Shortcut for redirecting to the servlet root.

Method Detail

getHttpResponseCode

public int getHttpResponseCode()

Returns the response code passed in through the constructor.

Returns:

The response code passed in through the constructor, or 0 if response code wasn't specified.

getURI

public URI getURI()

Returns the URI to redirect to.

Returns:

The URI to redirect to.