play.mvc

Class Call

java.lang.Object

play.mvc.Call

public abstract class Call
extends java.lang.Object

Defines a 'call', describing an HTTP request. For example used to create links or populate redirect data.

These values are usually generated by the reverse router.

Constructor Summary

Constructors

Constructor and Description
Call()

Method Summary

Modifier and Type	Method and Description
java.lang.String	absoluteURL(boolean secure, java.lang.String host) Transform this call to an absolute URL.
java.lang.String	absoluteURL(Http.Request request) Transform this call to an absolute URL.
java.lang.String	absoluteURL(Http.Request request, boolean secure) Transform this call to an absolute URL.
protected java.lang.String	appendFragment() Returns the fragment (including the leading "#") if this call has one.
java.lang.String	canonical() Transform this path into its canonical form.
abstract java.lang.String	fragment() The fragment of the URL.
abstract java.lang.String	method() The request HTTP method.
java.lang.String	path()
java.lang.String	relativeTo(Http.RequestHeader requestHeader) Transform this call to a relative path.
java.lang.String	relativeTo(java.lang.String startPath) Transform this call to a relative path.
java.lang.String	toString()
Call	unique() Append a unique identifier to the URL.
protected java.lang.String	uniquify(java.lang.String url)
abstract java.lang.String	url() The request URL.
java.lang.String	webSocketURL(boolean secure, java.lang.String host) Transform this call to an WebSocket URL.
java.lang.String	webSocketURL(Http.Request request) Transform this call to an WebSocket URL.
java.lang.String	webSocketURL(Http.Request request, boolean secure) Transform this call to an WebSocket URL.
Call	withFragment(java.lang.String fragment) Returns a new Call with the given fragment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Call

public Call()

Method Detail

url

public abstract java.lang.String url()

The request URL.

Returns:

the url

method

public abstract java.lang.String method()

The request HTTP method.

Returns:

the http method (e.g. "GET")

fragment

public abstract java.lang.String fragment()

The fragment of the URL.

Returns:

the fragment (without leading '#' character)

unique

public Call unique()

Append a unique identifier to the URL.

Returns:

a copy if this call with a unique identifier to this url

uniquify

protected final java.lang.String uniquify(java.lang.String url)

withFragment

public Call withFragment(java.lang.String fragment)

Returns a new Call with the given fragment.

Parameters:

fragment - the URL fragment

Returns:

a copy of this call that contains the fragment

appendFragment

protected java.lang.String appendFragment()

Returns the fragment (including the leading "#") if this call has one.

Returns:

the fragment, with leading "#"

absoluteURL

public java.lang.String absoluteURL(Http.Request request)

Transform this call to an absolute URL.

Parameters:

request - used to identify the host and protocol that should base this absolute URL

Returns:

the absolute URL string

absoluteURL

public java.lang.String absoluteURL(Http.Request request,
                                    boolean secure)

Transform this call to an absolute URL.

Parameters:

request - used to identify the host that should base this absolute URL

secure - true if the absolute URL should use HTTPS protocol

Returns:

the absolute URL string

absoluteURL

public java.lang.String absoluteURL(boolean secure,
                                    java.lang.String host)

Transform this call to an absolute URL.

Parameters:

secure - true if the absolute URL should use HTTPS protocol instead of HTTP

host - the absolute URL's domain

Returns:

the absolute URL string

webSocketURL

public java.lang.String webSocketURL(Http.Request request)

Transform this call to an WebSocket URL.

Parameters:

request - used as the base for forming the WS url

Returns:

the websocket url string

webSocketURL

public java.lang.String webSocketURL(Http.Request request,
                                     boolean secure)

Transform this call to an WebSocket URL.

Parameters:

request - used to identify the host for the absolute URL

secure - true if it should be a wss rather than ws URL

Returns:

the websocket URL string

webSocketURL

public java.lang.String webSocketURL(boolean secure,
                                     java.lang.String host)

Transform this call to an WebSocket URL.

Parameters:

host - the host for the absolute URL.

secure - true if it should be a wss rather than ws URL

Returns:

the url string

relativeTo

public java.lang.String relativeTo(Http.RequestHeader requestHeader)

Transform this call to a relative path.

Parameters:

requestHeader - used to identify the current URL to make this Call relative to.

Returns:

the relative path string

relativeTo

public java.lang.String relativeTo(java.lang.String startPath)

Transform this call to a relative path.

Parameters:

startPath - the URL to make this Call relative to.

Returns:

the relative path string

canonical

public java.lang.String canonical()

Transform this path into its canonical form.

Returns:

the canonical path.

path

public java.lang.String path()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object