Package | Description |
---|---|
org.restlet.client |
Core classes of the API.
|
org.restlet.client.data |
Information exchanged by components.
|
org.restlet.client.representation |
Common representation data elements.
|
org.restlet.client.resource |
Client and server resource classes.
|
org.restlet.client.util |
Various utility classes.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and 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.
|
Constructor and Description |
---|
Request(Method method,
Reference resourceRef)
Constructor.
|
Request(Method method,
Reference resourceRef,
Representation entity)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Reference |
Reference.addQueryParameter(Parameter parameter)
Adds a parameter to the query component.
|
Reference |
Reference.addQueryParameter(java.lang.String name,
java.lang.String value)
Adds a parameter to the query component.
|
Reference |
Reference.addQueryParameters(java.lang.Iterable<Parameter> parameters)
Adds several parameters to the query component.
|
Reference |
Reference.addSegment(java.lang.String value)
Adds a segment at the end of the path.
|
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 |
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.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Reference> |
ChallengeRequest.getDomainRefs()
Returns the base URI references that collectively define the protected
domains for the digest authentication.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
void |
ChallengeRequest.setDomainRefs(java.util.List<Reference> domainRefs)
Sets the URI references that define the protection domains for the digest
authentication.
|
Constructor and Description |
---|
ChallengeResponse(ChallengeScheme scheme,
Series<Parameter> parameters,
java.lang.String identifier,
char[] secret,
java.lang.String secretAlgorithm,
java.lang.String realm,
java.lang.String quality,
Reference digestRef,
java.lang.String digestAlgorithm,
java.lang.String opaque,
java.lang.String clientNonce,
java.lang.String serverNonce,
int serverNounceCount,
long timeIssued)
Constructor.
|
Reference(Reference ref)
Clone constructor.
|
Reference(Reference baseRef,
Reference uriReference)
Constructor from an URI reference (most likely relative).
|
Reference(Reference baseRef,
java.lang.String uriRef)
Constructor from an URI reference (most likely relative).
|
Reference(Reference baseRef,
java.lang.String relativePart,
java.lang.String query,
java.lang.String fragment)
Constructor of relative reference from its parts.
|
Constructor and Description |
---|
ReferenceList(java.util.List<Reference> delegate)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Reference |
Variant.getLocationRef()
Returns an optional location reference.
|
Modifier and Type | Method and Description |
---|---|
void |
Variant.setLocationRef(Reference location)
Sets the optional identifier.
|
Modifier and Type | Method and Description |
---|---|
Reference |
ClientResource.addQueryParameter(Parameter parameter)
Adds a parameter to the query component.
|
Reference |
ClientResource.addQueryParameter(java.lang.String name,
java.lang.String value)
Adds a parameter to the query component.
|
Reference |
ClientResource.addQueryParameters(java.lang.Iterable<Parameter> parameters)
Adds several parameters to the query component.
|
Reference |
ClientResource.addSegment(java.lang.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 |
Resource.getRootRef()
Returns the application root reference.
|
Modifier and Type | Method and Description |
---|---|
ClientResource |
ClientResource.getChild(Reference relativeRef)
Returns the child resource defined by its URI relatively to the current
resource.
|
void |
ClientResource.setHostRef(Reference hostRef)
Sets the host reference.
|
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.
|
Modifier and Type | Method and Description |
---|---|
protected void |
ClientResource.handle(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Handle the call and follow redirection for safe methods.
|
protected void |
ClientResource.redirect(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Effectively redirects a client call.
|
protected void |
ClientResource.retry(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Effectively retries a failed client call.
|
Constructor and 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.
|
Modifier and Type | Method and Description |
---|---|
Reference |
WrapperRequest.getHostRef()
Returns the host reference.
|
Reference |
WrapperResponse.getLocationRef()
Returns the reference that the client should follow for redirections or
resource creations.
|
Reference |
WrapperRepresentation.getLocationRef() |
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.
|
Modifier and Type | Method and 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 |
WrapperResponse.setLocationRef(Reference locationRef)
Sets the reference that the client should follow for redirections or
resource creations.
|
void |
WrapperRepresentation.setLocationRef(Reference location) |
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.
|
Copyright © 2005-2024 Restlet.