Uses of Class
org.restlet.data.Reference

Packages that use Reference

Package	Description
org.restlet	Core classes of the Restlet API.
org.restlet.data	Information exchanged by components.
org.restlet.engine.adapter	Adapters between low-level HTTP calls and high-level Restlet Request and Response objects.
org.restlet.engine.local	Supports local connectors and resources.
org.restlet.engine.security	Supports security.
org.restlet.engine.util	General utilities.
org.restlet.representation	Common representation data elements.
org.restlet.resource	Client and server resource classes.
org.restlet.routing	Classes related to call routing.
org.restlet.service	Services used by applications and components.
org.restlet.util	Various utility classes.

Uses of Reference in org.restlet

Methods in org.restlet that return Reference

Modifier and Type	Method	Description
Reference	Request.getHostRef()	Returns the host reference.
Reference	Response.getLocationRef()	Returns the location reference.
Reference	Request.getOriginalRef()	Returns the original reference as requested by the client.
Reference	Request.getReferrerRef()	Returns the referrer reference if available.
Reference	Request.getResourceRef()	Returns the reference of the target resource.
Reference	Request.getRootRef()	Returns the application root reference.

Methods in org.restlet with parameters of type Reference

Modifier and Type	Method	Description
void	Response.redirectPermanent(Reference targetRef)	Permanently redirects the client to a target URI.
void	Response.redirectSeeOther(Reference targetRef)	Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
void	Response.redirectTemporary(Reference targetRef)	Temporarily redirects the client to a target URI.
void	Request.setHostRef(Reference hostRef)	Sets the host reference.
void	Response.setLocationRef(Reference locationRef)	Sets the reference that the client should follow for redirections or resource creations.
void	Request.setOriginalRef(Reference originalRef)	Sets the original reference requested by the client.
void	Request.setReferrerRef(Reference referrerRef)	Sets the referrer reference if available.
void	Request.setResourceRef(Reference resourceRef)	Sets the target resource reference.
void	Request.setRootRef(Reference rootRef)	Sets the application root reference.

Constructors in org.restlet with parameters of type Reference

Modifier	Constructor	Description
	Request(Method method, Reference resourceRef)	Constructor.
	Request(Method method, Reference resourceRef, Representation entity)	Constructor.

Uses of Reference in org.restlet.data

Subclasses of Reference in org.restlet.data

Modifier and Type	Class	Description
final class	LocalReference	Reference to a local resource.

Methods in org.restlet.data that return Reference

Modifier and Type	Method	Description
Reference	Reference.addQueryParameter(String name, String value)	Adds a parameter to the query component.
Reference	Reference.addQueryParameter(Parameter parameter)	Adds a parameter to the query component.
Reference	Reference.addQueryParameters(Iterable<Parameter> parameters)	Adds several parameters to the query component.
Reference	Reference.addSegment(String value)	Adds a segment at the end of the path.
Reference	Reference.clone()
Reference	Reference.getBaseRef()	Returns the base reference for relative references.
Reference	ChallengeResponse.getDigestRef()	Returns the Request.getResourceRef() value duplicated here in case a proxy changed it.
Reference	ReferenceList.getIdentifier()	Returns the list identifier.
Reference	LocalReference.getJarFileRef()	Returns the JAR file reference.
Reference	Reference.getParentRef()	Returns the parent reference of a hierarchical reference.
Reference	Reference.getRelativeRef()	Returns the current reference as a relative reference to the current base reference.
Reference	Reference.getRelativeRef(Reference base)	Returns the current reference relatively to a base reference.
Reference	Reference.getTargetRef()	Returns the target reference.
Reference	Reference.normalize()	Normalizes the reference.

Methods in org.restlet.data that return types with arguments of type Reference

Modifier and Type	Method	Description
List<Reference>	ChallengeRequest.getDomainRefs()	Returns the base URI references that collectively define the protected domains for the digest authentication.

Methods in org.restlet.data with parameters of type Reference

Modifier and Type	Method	Description
static LocalReference	LocalReference.createJarReference(Reference jarFile, String entryPath)	Constructor.
static LocalReference	LocalReference.createZipReference(Reference zipFile, String entryPath)	Constructor.
Reference	Reference.getRelativeRef(Reference base)	Returns the current reference relatively to a base reference.
boolean	Reference.isEquivalentTo(Reference ref)	Returns true if both reference are equivalent, meaning that they resolve to the same target reference.
boolean	Reference.isParent(Reference childRef)	Indicates if the reference is a parent of the hierarchical child reference.
void	Reference.setBaseRef(Reference baseRef)	Sets the base reference for relative references.
void	ChallengeResponse.setDigestRef(Reference digestRef)	Sets the digest URI reference.
void	ReferenceList.setIdentifier(Reference identifier)	Sets the list reference.

Method parameters in org.restlet.data with type arguments of type Reference

Modifier and Type	Method	Description
void	ChallengeRequest.setDomainRefs(List<Reference> domainRefs)	Sets the URI references that define the protection domains for the digest authentication.

Constructors in org.restlet.data with parameters of type Reference

Modifier	Constructor	Description
	ChallengeResponse(ChallengeScheme scheme, Series<Parameter> parameters, String identifier, char[] secret, String secretAlgorithm, String realm, String quality, Reference digestRef, String digestAlgorithm, String opaque, String clientNonce, String serverNonce, int serverNonceCount, long timeIssued)	Constructor.
	LocalReference(Reference localRef)	Constructor.
	Reference(Reference ref)	Clone constructor.
	Reference(Reference baseRef, String uriRef)	Constructor from a URI reference (most likely relative).
	Reference(Reference baseRef, String relativePart, String query, String fragment)	Constructor of relative reference from its parts.
	Reference(Reference baseRef, Reference uriReference)	Constructor from an URI reference (most likely relative).

Constructor parameters in org.restlet.data with type arguments of type Reference

Modifier	Constructor	Description
	ReferenceList(List<Reference> delegate)	Constructor.

Uses of Reference in org.restlet.engine.adapter

Methods in org.restlet.engine.adapter that return Reference

Modifier and Type	Method	Description
Reference	HttpRequest.getReferrerRef()	Returns the referrer reference if available.

Uses of Reference in org.restlet.engine.local

Methods in org.restlet.engine.local that return Reference

Modifier and Type	Method	Description
Reference	EntityClientHelper.createReference(String scheme, String encodedParentDirPath, String encodedEntityName, String decodedVariantName)	Generate a Reference for a variant name (which is URL decoded) and handle the translation between the incoming requested path (which is URL encoded).

Uses of Reference in org.restlet.engine.security

Methods in org.restlet.engine.security that return Reference

Modifier and Type	Method	Description
Reference	AuthenticatorHelper.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request)	Optionally updates the request with a challenge response before sending it.
static Reference	AuthenticatorUtils.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request)	Optionally updates the request with a challenge response before sending it.

Methods in org.restlet.engine.security with parameters of type Reference

Modifier and Type	Method	Description
Reference	AuthenticatorHelper.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request)	Optionally updates the request with a challenge response before sending it.
static Reference	AuthenticatorUtils.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request)	Optionally updates the request with a challenge response before sending it.

Uses of Reference in org.restlet.engine.util

Methods in org.restlet.engine.util that return Reference

Modifier and Type	Method	Description
static Reference	ReferenceUtils.getOriginalRef(Reference resourceRef, Series<Header> headers)	Returns the original reference especially by detecting potential proxy forwardings.
static Reference	ReferenceUtils.update(Reference resourceRef, Request request)	Returns the request URI.

Methods in org.restlet.engine.util with parameters of type Reference

Modifier and Type	Method	Description
int	AlphabeticalComparator.compare(Reference ref0, Reference ref1)	Compares two references.
static String	ReferenceUtils.format(Reference resourceRef, boolean isProxied, Request request)	Returns the request URI.
static Reference	ReferenceUtils.getOriginalRef(Reference resourceRef, Series<Header> headers)	Returns the original reference especially by detecting potential proxy forwardings.
static Reference	ReferenceUtils.update(Reference resourceRef, Request request)	Returns the request URI.

Uses of Reference in org.restlet.representation

Methods in org.restlet.representation that return Reference

Modifier and Type	Method	Description
Reference	Variant.getLocationRef()	Returns an optional location reference.

Methods in org.restlet.representation with parameters of type Reference

Modifier and Type	Method	Description
void	Variant.setLocationRef(Reference location)	Sets the optional identifier.

Uses of Reference in org.restlet.resource

Methods in org.restlet.resource that return Reference

Modifier and Type	Method	Description
Reference	ClientResource.addQueryParameter(String name, String value)	Adds a parameter to the query component.
Reference	ClientResource.addQueryParameter(Parameter parameter)	Adds a parameter to the query component.
Reference	ClientResource.addQueryParameters(Iterable<Parameter> parameters)	Adds several parameters to the query component.
Reference	ClientResource.addSegment(String value)	Adds a segment at the end of the path.
Reference	Resource.getHostRef()	Returns the host reference.
Reference	Resource.getLocationRef()	Returns the reference that the client should follow for redirections or resource creations.
Reference	Resource.getOriginalRef()	Returns the original reference as requested by the client.
Reference	Resource.getReference()	Returns the URI reference.
Reference	Resource.getReferrerRef()	Returns the referrer reference if available.
Reference	Directory.getRootRef()	Returns the root URI from which the relative resource URIs will be looked up.
Reference	Resource.getRootRef()	Returns the application root reference.

Methods in org.restlet.resource that return types with arguments of type Reference

Modifier and Type	Method	Description
Comparator<Reference>	Directory.getComparator()	Returns the reference comparator used to sort index pages.

Methods in org.restlet.resource with parameters of type Reference

Modifier and Type	Method	Description
static <T> T	ClientResource.create(Context context, Reference reference, Class<? extends T> resourceInterface)	Creates a client resource that proxy calls to the given Java interface into Restlet method calls.
static <T> T	ClientResource.create(Reference reference, Class<? extends T> resourceInterface)	Creates a client resource that proxy calls to the given Java interface into Restlet method calls.
ClientResource	ClientResource.getChild(Reference relativeRef)	Returns the child resource defined by its URI relatively to the current resource.
<T> T	ClientResource.getChild(Reference relativeRef, Class<? extends T> resourceInterface)	Wraps the child client resource to proxy calls to the given Java interface into Restlet method calls.
void	ServerResource.redirectPermanent(Reference targetRef)	Permanently redirects the client to a target URI.
void	ServerResource.redirectSeeOther(Reference targetRef)	Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
void	ServerResource.redirectTemporary(Reference targetRef)	Temporarily redirects the client to a target URI.
void	ClientResource.setHostRef(Reference hostRef)	Sets the host reference.
void	ServerResource.setLocationRef(Reference locationRef)	Sets the reference that the client should follow for redirections or resource creations.
void	ClientResource.setOriginalRef(Reference originalRef)	Sets the original reference requested by the client.
void	ClientResource.setReference(Reference reference)	Sets the resource's reference.
void	ClientResource.setReferrerRef(Reference referrerRef)	Sets the referrer reference if available.
void	Directory.setRootRef(Reference rootRef)	Sets the root URI from which the relative resource URIs will be lookep up.

Method parameters in org.restlet.resource with type arguments of type Reference

Modifier and Type	Method	Description
protected void	ClientResource.handle(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next)	Handle the call and follow redirection for safe methods.
protected void	ClientResource.redirect(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next)	Effectively redirects a client call.
protected void	ClientResource.retry(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next)	Effectively retries a failed client call.
void	Directory.setComparator(Comparator<Reference> comparator)	Sets the reference comparator used to sort index pages.

Constructors in org.restlet.resource with parameters of type Reference

Modifier	Constructor	Description
	ClientResource(Context context, Method method, Reference reference)	Constructor.
	ClientResource(Context context, Reference reference)	Constructor.
	ClientResource(Method method, Reference reference)	Constructor.
	ClientResource(Reference reference)	Constructor.
	Directory(Context context, Reference rootLocalReference)	Constructor.

Uses of Reference in org.restlet.routing

Methods in org.restlet.routing that return Reference

Modifier and Type	Method	Description
protected Reference	Redirector.getTargetRef(Request request, Response response)	Returns the target reference to redirect to by automatically resolving URI template variables found using the Template class using the request and response as data models.

Methods in org.restlet.routing with parameters of type Reference

Modifier and Type	Method	Description
protected void	Redirector.inboundServerRedirect(Reference targetRef, Request request, Response response)	Redirects a given call to a target reference.
protected void	Redirector.outboundServerRedirect(Reference targetRef, Request request, Response response)	Redirects a given call to a target reference.
protected void	Redirector.serverRedirect(Restlet next, Reference targetRef, Request request, Response response)	Redirects a given call on the server-side to a next Restlet with a given target reference.

Uses of Reference in org.restlet.service

Methods in org.restlet.service that return Reference

Modifier and Type	Method	Description
Reference	StatusService.getHomeRef()	Returns the home URI to propose in case of error.
Reference	LogService.getLogPropertiesRef()	Returns the URI reference of the log properties.

Methods in org.restlet.service with parameters of type Reference

Modifier and Type	Method	Description
void	StatusService.setHomeRef(Reference homeRef)	Sets the home URI to propose in case of error.
void	LogService.setLogPropertiesRef(Reference logPropertiesRef)	Sets the URI reference of the log properties.

Uses of Reference in org.restlet.util

Methods in org.restlet.util that return Reference

Modifier and Type	Method	Description
Reference	WrapperRequest.getHostRef()	Returns the host reference.
Reference	WrapperRepresentation.getLocationRef()
Reference	WrapperResponse.getLocationRef()	Returns the reference that the client should follow for redirections or resource creations.
Reference	WrapperRequest.getOriginalRef()
Reference	WrapperRequest.getReferrerRef()	Returns the referrer reference if available.
Reference	WrapperRequest.getResourceRef()	Returns the reference of the target resource.
Reference	WrapperRequest.getRootRef()	Returns the application root reference.

Methods in org.restlet.util with parameters of type Reference

Modifier and Type	Method	Description
void	WrapperResponse.redirectPermanent(Reference targetRef)	Permanently redirects the client to a target URI.
void	WrapperResponse.redirectSeeOther(Reference targetRef)	Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
void	WrapperResponse.redirectTemporary(Reference targetRef)	Temporarily redirects the client to a target URI.
void	WrapperRequest.setHostRef(Reference hostRef)	Sets the host reference.
void	WrapperRepresentation.setLocationRef(Reference location)
void	WrapperResponse.setLocationRef(Reference locationRef)	Sets the reference that the client should follow for redirections or resource creations.
void	WrapperRequest.setOriginalRef(Reference originalRef)
void	WrapperRequest.setReferrerRef(Reference referrerRef)	Sets the referrer reference if available.
void	WrapperRequest.setResourceRef(Reference resourceRef)	Sets the target resource reference.
void	WrapperRequest.setRootRef(Reference rootRef)	Sets the application root reference.