Index (Rhino REST API Framework)

A B C D E F G H I J L M N O P R S T U V W X
All Classes All Packages

A

addHeader(String, String) - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder: Add a header to the rest request
ApiConfiguration - Class in com.opencloud.slee.rest.common: The configuration to be used with a generated REST API.
ApiOption<T> - Class in com.opencloud.slee.rest.common: A configuration option.
ApiOption(String) - Constructor for class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option
ApiOptions - Class in com.opencloud.slee.rest.common: A set of common API options.
ApiOptions.PreferredBodyType - Enum in com.opencloud.slee.rest.common: Specify which encoding should be preferred if an operation allows both JSON and XML bodies

B

Base64EncodedVerifier() - Constructor for class com.opencloud.slee.rest.common.Verifier.Base64EncodedVerifier
base64PasswordOption(String) - Static method in class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option, with a value that is a String containing base64 characters
baseConfiguration() - Static method in class com.opencloud.slee.rest.common.ApiConfiguration: Create an ApiConfiguration suitable for custom/hand-written APIs.
booleanOption(String) - Static method in class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option, with a value that is a boolean
build(IncomingRestActivity) - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder

C

clusterCallbackUrl - Static variable in class com.opencloud.slee.rest.common.ApiOptions: The base URL to be used for a callback, that will target the cluster (optional)
com.opencloud.slee.rest.common - package com.opencloud.slee.rest.common: The service visible API used by Rhino based applications.
createResponse(int, String) - Method in interface com.opencloud.slee.rest.common.IncomingRestActivity
createResponse(int, String, String) - Method in interface com.opencloud.slee.rest.common.RestResponseCreator: Create a new response

D

DELETE - com.opencloud.slee.rest.common.HttpMethod
destinationUrl - Static variable in class com.opencloud.slee.rest.common.ApiOptions: The destination URL to be used when sending API requests (other than callbacks)

E

encodeHeaderListValue(Class<T>, List<T>) - Method in interface com.opencloud.slee.rest.common.RestResponseCreator
encodeHeaderValue(Class<T>, T) - Method in interface com.opencloud.slee.rest.common.RestResponseCreator
encodeResponseBody(String, Object) - Method in interface com.opencloud.slee.rest.common.RestResponseCreator: Encode the response body
endActivity() - Method in interface com.opencloud.slee.rest.common.RestActivity
enumOption(String, E) - Static method in class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option, with a value that is an Enum
equals(Object) - Method in class com.opencloud.slee.rest.common.ApiOption
explain() - Method in class com.opencloud.slee.rest.common.VerifyResult

F

failed() - Static method in class com.opencloud.slee.rest.common.VerifyResult
failed(String) - Static method in class com.opencloud.slee.rest.common.VerifyResult
FAILED - Static variable in class com.opencloud.slee.rest.common.VerifyResult
fromString(String) - Static method in enum com.opencloud.slee.rest.common.HttpMethod

G

get(ApiOption<T>) - Method in class com.opencloud.slee.rest.common.ApiConfiguration: Get the value of an option
GET - com.opencloud.slee.rest.common.HttpMethod
getActivityContextInterface(IncomingRestActivity) - Method in interface com.opencloud.slee.rest.common.RestACIFactory
getActivityContextInterface(OutgoingRestActivity) - Method in interface com.opencloud.slee.rest.common.RestACIFactory
getApi() - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder
getApi() - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder
getClientAddress() - Method in interface com.opencloud.slee.rest.common.RestRequest: Returns the address of the HTTP client (for incoming requests).
getClientCertificates() - Method in interface com.opencloud.slee.rest.common.RestRequest: Returns the certificates sent by the HTTP client (for incoming HTTPS requests that used client certificate authentication).
getContent() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the message's content, as a byte array.
getContent() - Method in interface com.opencloud.slee.rest.common.RestResponse
getContentLength() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the message's Content-Length.
getContentLength() - Method in interface com.opencloud.slee.rest.common.RestResponse
getContentType() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the message's Content-Type header.
getContentType() - Method in interface com.opencloud.slee.rest.common.RestResponse
getHeader(String) - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the value of a HTTP header.
getHeader(String) - Method in interface com.opencloud.slee.rest.common.RestResponse
getHeaderNames() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get an iterator returning a String for each header present in this message.
getHeaderNames() - Method in interface com.opencloud.slee.rest.common.RestResponse
getLocalAddress() - Method in interface com.opencloud.slee.rest.common.RestRequest: Return the local address of the HTTP server that the client is connected to (for incoming requests).
getOperationId() - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder
getOperationId() - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder
getRequest() - Method in interface com.opencloud.slee.rest.common.IncomingRestActivity
getRequest() - Method in interface com.opencloud.slee.rest.common.OutgoingRestActivity
getRequest() - Method in interface com.opencloud.slee.rest.common.RestRequestEvent
getRequestURI() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the Request-URI specified in the Request-Line of the HTTP request, as defined in section 5.1.2 of RFC 2616.
getRequestURL() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the request URL of this request, including the host.
getResponse() - Method in interface com.opencloud.slee.rest.common.RestResponseEvent
getStatusCode() - Method in interface com.opencloud.slee.rest.common.RestResponse
getStatusReason() - Method in interface com.opencloud.slee.rest.common.RestResponse
getTrail() - Method in interface com.opencloud.slee.rest.common.RestRequest
getTrail() - Method in interface com.opencloud.slee.rest.common.RestResponse

H

hashCode() - Method in class com.opencloud.slee.rest.common.ApiOption
hasPreference() - Method in enum com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType
HEAD - com.opencloud.slee.rest.common.HttpMethod
HttpMethod - Enum in com.opencloud.slee.rest.common: HTTP request methods.

I

IncomingRestActivity - Interface in com.opencloud.slee.rest.common: A SLEE activity related to an incoming REST request.
initialValue() - Method in class com.opencloud.slee.rest.common.ApiOption: Get the initial value
isServerResponse() - Method in interface com.opencloud.slee.rest.common.RestResponse
isSet(ApiOption<T>) - Method in class com.opencloud.slee.rest.common.ApiConfiguration: Check if an option has an associated value
isValid() - Method in class com.opencloud.slee.rest.common.VerifyResult

J

JSON - com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType

L

localCallbackUrl - Static variable in class com.opencloud.slee.rest.common.ApiOptions: The base URL to be used for a callback, that will target the current cluster node (optional)

M

method() - Method in interface com.opencloud.slee.rest.common.RestRequest: Get the HTTP request method of this request.

N

name() - Method in class com.opencloud.slee.rest.common.ApiOption: Get the configuration option name
newRequest(HttpMethod, URI) - Method in interface com.opencloud.slee.rest.common.RestProvider: Create a new REST request
NONE - com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType
NoOpVerifier() - Constructor for class com.opencloud.slee.rest.common.Verifier.NoOpVerifier
NotEmptyStringVerifier() - Constructor for class com.opencloud.slee.rest.common.Verifier.NotEmptyStringVerifier
NotNullVerifier() - Constructor for class com.opencloud.slee.rest.common.Verifier.NotNullVerifier

O

ok() - Static method in class com.opencloud.slee.rest.common.VerifyResult
OK - Static variable in class com.opencloud.slee.rest.common.VerifyResult
OPTIONS - com.opencloud.slee.rest.common.HttpMethod
OutgoingRestActivity - Interface in com.opencloud.slee.rest.common: A SLEE activity related to an outgoing REST request created by a service.

P

password - Static variable in class com.opencloud.slee.rest.common.ApiOptions: The password for HTTP Basic authentication.
PATCH - com.opencloud.slee.rest.common.HttpMethod
POST - com.opencloud.slee.rest.common.HttpMethod
preferJSON() - Method in enum com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType
preferredBodyType - Static variable in class com.opencloud.slee.rest.common.ApiOptions: If an operation allows more than one content type, send using XML or JSON as specified.
preferXML() - Method in enum com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType
PUT - com.opencloud.slee.rest.common.HttpMethod

R

removeHeader(String) - Method in interface com.opencloud.slee.rest.common.RestResponse
RestACIFactory - Interface in com.opencloud.slee.rest.common: The SLEE ACI factory for REST APIs, which an application uses to retrieve an ActivityContextInterface from a REST activity.
RestActivity - Interface in com.opencloud.slee.rest.common: Defines operations common to incoming and outgoing REST activities.
RestProvider - Interface in com.opencloud.slee.rest.common: The provider interface for the built-in REST API supplied by a REST RA.
RestRequest - Interface in com.opencloud.slee.rest.common: The standard SLEE events, corresponding to incoming REST requests, defined by the built-in REST API provided by a REST RA.
RestRequestBuilder - Interface in com.opencloud.slee.rest.common: Represent a REST request being constructed.
RestRequestEvent - Interface in com.opencloud.slee.rest.common
RestResponse - Interface in com.opencloud.slee.rest.common: The standard SLEE events, corresponding to incoming REST responses, defined by the built-in REST API provided by a REST RA.
RestResponseBuilder - Interface in com.opencloud.slee.rest.common: Represent a REST response being constructed.
RestResponseCreator - Interface in com.opencloud.slee.rest.common: The interface between generated event classes and the REST RA.
RestResponseEvent - Interface in com.opencloud.slee.rest.common

S

SasReportable - Interface in com.opencloud.slee.rest.common: Implemented by generated objects that may be reported by SAS.
sendRequest(RestRequest) - Method in interface com.opencloud.slee.rest.common.RestProvider: Send a REST request.
set(ApiOption<T>, T) - Method in class com.opencloud.slee.rest.common.ApiConfiguration: Set the value of an option
setContent(String, byte[]) - Method in interface com.opencloud.slee.rest.common.RestResponse
setContent(String, Object, byte[]) - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder: Set the content of the rest request.
setContent(String, Object, byte[]) - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder: Set the content of the rest response.
setCookieHeader(String) - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder: Set the cookie header
setHeader(String, String) - Method in interface com.opencloud.slee.rest.common.RestResponse
setHeader(String, String) - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder: Set a header in the response.
setRequestUrl(URL) - Method in interface com.opencloud.slee.rest.common.RestRequestBuilder: Set the request URL
setStatus(int) - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder: Set the response status
setStatus(int, String) - Method in interface com.opencloud.slee.rest.common.RestResponseBuilder: Set the response status and reason
standardConfiguration() - Static method in class com.opencloud.slee.rest.common.ApiConfiguration: Create an ApiConfiguration suitable for generated APIs.
stringOption(String) - Static method in class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option, with a value that is a non-empty String

T

toSimpleString(StringBuilder) - Method in interface com.opencloud.slee.rest.common.SasReportable
toString() - Method in class com.opencloud.slee.rest.common.ApiConfiguration
toString() - Method in class com.opencloud.slee.rest.common.ApiOption
toString() - Method in class com.opencloud.slee.rest.common.VerifyResult
TRACE - com.opencloud.slee.rest.common.HttpMethod

U

urlOption(String) - Static method in class com.opencloud.slee.rest.common.ApiOption: Create a new configuration option, with a value that is a valid URL
UrlVerifier() - Constructor for class com.opencloud.slee.rest.common.Verifier.UrlVerifier
userName - Static variable in class com.opencloud.slee.rest.common.ApiOptions: The username for HTTP Basic authentication

V

valueOf(String) - Static method in enum com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opencloud.slee.rest.common.HttpMethod: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opencloud.slee.rest.common.HttpMethod: Returns an array containing the constants of this enum type, in the order they are declared.
Verifier<T> - Interface in com.opencloud.slee.rest.common: Defines a function that verifies config property values.
Verifier.Base64EncodedVerifier - Class in com.opencloud.slee.rest.common: Verify that a String property value contains valid base64 characters
Verifier.NoOpVerifier<T> - Class in com.opencloud.slee.rest.common: Always consider that a property value is valid.
Verifier.NotEmptyStringVerifier - Class in com.opencloud.slee.rest.common: Verify that a String property value is not an empty string
Verifier.NotNullVerifier<T> - Class in com.opencloud.slee.rest.common: Verify that a property value may not be null
Verifier.UrlVerifier - Class in com.opencloud.slee.rest.common: Verify that a String property value is a valid URL
verify() - Method in class com.opencloud.slee.rest.common.ApiConfiguration: Verify that all options, that have been set, have valid values.
verify(String) - Method in class com.opencloud.slee.rest.common.Verifier.Base64EncodedVerifier
verify(String) - Method in class com.opencloud.slee.rest.common.Verifier.NotEmptyStringVerifier
verify(String) - Method in class com.opencloud.slee.rest.common.Verifier.UrlVerifier
verify(T) - Method in class com.opencloud.slee.rest.common.ApiOption: Verify the validity of a value with respect to this configuration option
verify(T) - Method in class com.opencloud.slee.rest.common.Verifier.NoOpVerifier
verify(T) - Method in class com.opencloud.slee.rest.common.Verifier.NotNullVerifier
verify(T) - Method in interface com.opencloud.slee.rest.common.Verifier: Verify a config property value.
VerifyResult - Class in com.opencloud.slee.rest.common: The outcome of verifying an ApiConfiguration.
Version - Class in com.opencloud.slee.rest.common
Version() - Constructor for class com.opencloud.slee.rest.common.Version
VERSION - Static variable in class com.opencloud.slee.rest.common.Version

W

withExplanation(String) - Method in class com.opencloud.slee.rest.common.VerifyResult
withOption(ApiOption<?>) - Method in class com.opencloud.slee.rest.common.ApiConfiguration: Add a new option to the configuration (for custom API implementations).

X

XML - com.opencloud.slee.rest.common.ApiOptions.PreferredBodyType

A B C D E F G H I J L M N O P R S T U V W X
All Classes All Packages