oracle.adf.model.connection.rest

Class RestConnection

java.lang.Object

oracle.adf.model.connection.rest.RestConnection

All Implemented Interfaces:

javax.naming.Referenceable

public class RestConnection
extends java.lang.Object
implements javax.naming.Referenceable

Supported Jersey version Jersey2.9 in 12C release.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_NAME Connection Name attribute
static java.lang.String	ATTR_URL Connection endpoint attribute
static java.lang.String	HEADER
static java.lang.String	HEADER_KEY
static java.lang.String	HEADER_VALUE
static java.lang.String	HTTP_HEADERS_MAP Http Headers Map attribute.
static java.lang.String	IS_ADFBC_MODE Saves the adfbcMode in connection.
static java.lang.String	IS_CSRF_HEADER
static java.lang.String	REST_CONNECTION_INVOKER_DELEGATE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestConnection(java.lang.String name, org.w3c.dom.DocumentFragment description, java.util.Hashtable environment) Instantiate this RestConnection instance from the description and the corresponding environment.
	RestConnection(java.lang.String name, java.net.URL url)
	RestConnection(java.lang.String name, java.net.URL url, java.util.Map<java.lang.String,java.lang.Object> clientConfigProperties)

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.DocumentFragment	describe() Create the DocumentFragment that describes this connection to the Connection Architecture.
ConnectionAuthentication	getAuthenticationScheme() Get the ConnectionAuthentication used by this connection to authenticate against the endpoint
java.lang.String	getName()
RestProxy	getProxy()
javax.naming.Reference	getReference()
java.net.URL	getResourcePatternURL() Returned value is same as that of getURL() when isADFBCMode is false In case when Connection is in adfBCMode (default) then this URL strips of ending "/describe" from URL if present and returns the URL.
RestResponse	getResponse(java.lang.String httpMethod, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> urlQueryMap, java.util.Map<java.lang.String,java.lang.Object> fixedHeaders, byte[] requestBody, java.lang.String contentType) Fetches the connection response for given HTTP operation and parameters.
RestResponse	getResponse(java.lang.String httpMethod, java.lang.String path, java.lang.String urlQueryString, java.util.Map<java.lang.String,java.lang.Object> fixedHeaders, byte[] requestBody, java.lang.String contentType) Deprecated. use the version that takes map as URL query parameter Fetches the connection response for given HTTP operation and parameters. Internal: Applications should not call this method.
RestResponse	getResponse(java.lang.String httpMethod, java.lang.String path, java.lang.String urlQueryString, java.util.Map<java.lang.String,java.lang.Object> fixedHeaders, java.util.Map<java.lang.String,java.lang.Object> userProvidedHeaders, byte[] requestBody, java.lang.String contentType) Deprecated. use the version that takes map as URL query parameter Fetches the connection response for given HTTP operation and parameters. Internal: Applications should not call this method.
int	getTimeout()
java.net.URL	getURL() Returns the URL associated with the connection
protected java.lang.String	getURLConnectionClassName()
boolean	isADFBCMode() Deprecated.
void	setADFBCMode(boolean adfbcMode) Deprecated.
protected void	setAuthenticationScheme(ConnectionAuthentication authScheme) Registers an ConnectionAuthentication for this connection to use when authenticating against the Resource.
void	setProxy(RestProxy proxy)
void	setTimeout(int timeout) Timeout interval in milliseconds If 0 then an interval of infinity is declared.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME

public static final java.lang.String ATTR_NAME

Connection Name attribute

See Also:

Constant Field Values

ATTR_URL

public static final java.lang.String ATTR_URL

Connection endpoint attribute

See Also:

Constant Field Values

IS_ADFBC_MODE

public static final java.lang.String IS_ADFBC_MODE

Saves the adfbcMode in connection. If Not specified in Attributes, holds default=true value.

See Also:

Constant Field Values

IS_CSRF_HEADER

public static final java.lang.String IS_CSRF_HEADER

See Also:

Constant Field Values

HTTP_HEADERS_MAP

public static final java.lang.String HTTP_HEADERS_MAP

Http Headers Map attribute.

See Also:

Constant Field Values

HEADER

public static final java.lang.String HEADER

See Also:

Constant Field Values

HEADER_KEY

public static final java.lang.String HEADER_KEY

See Also:

Constant Field Values

HEADER_VALUE

public static final java.lang.String HEADER_VALUE

See Also:

Constant Field Values

REST_CONNECTION_INVOKER_DELEGATE

public static final java.lang.String REST_CONNECTION_INVOKER_DELEGATE

See Also:

Constant Field Values

Constructor Detail

RestConnection

public RestConnection(java.lang.String name,
                      java.net.URL url,
                      java.util.Map<java.lang.String,java.lang.Object> clientConfigProperties)

RestConnection

public RestConnection(java.lang.String name,
                      java.net.URL url)

RestConnection

protected RestConnection(java.lang.String name,
                         org.w3c.dom.DocumentFragment description,
                         java.util.Hashtable environment)
                  throws ConnectionException

Instantiate this RestConnection instance from the description and the corresponding environment.

Parameters:

name - The Name of this Connection.

description - The DocumentFragment describing this connection

Environment - The Environment having the necessary credential information for this connection.

Throws:

{@link - ConnectionException} if the connection instance could not be created.

ConnectionException

Method Detail

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException

Specified by:

getReference in interface javax.naming.Referenceable

Throws:

javax.naming.NamingException

getAuthenticationScheme

public ConnectionAuthentication getAuthenticationScheme()

Get the ConnectionAuthentication used by this connection to authenticate against the endpoint

Returns:

The ConnectionAuthentication used by this connection. If the connection does not use any authentication null is returned.

setAuthenticationScheme

protected void setAuthenticationScheme(ConnectionAuthentication authScheme)

Registers an ConnectionAuthentication for this connection to use when authenticating against the Resource. The ConnectionAuthentication allows for extensions, to define custom authentication modules for a connection.

Parameters:

authScheme - ConnectionAuthentication to be used when authenticating against the resource.

describe

protected org.w3c.dom.DocumentFragment describe()
                                         throws ConnectionException

Create the DocumentFragment that describes this connection to the Connection Architecture. The Connection Architecture will then provide this description to the Connection Factory to recreate this connection instance

Returns:

The DocumentFragment describing this connection instance.

Throws:

ConnectionException

getName

public java.lang.String getName()

setProxy

public void setProxy(RestProxy proxy)

getProxy

public RestProxy getProxy()

getResponse

@Deprecated
public RestResponse getResponse(java.lang.String httpMethod,
                                            java.lang.String path,
                                            java.lang.String urlQueryString,
                                            java.util.Map<java.lang.String,java.lang.Object> fixedHeaders,
                                            java.util.Map<java.lang.String,java.lang.Object> userProvidedHeaders,
                                            byte[] requestBody,
                                            java.lang.String contentType)

Deprecated. use the version that takes map as URL query parameter

Fetches the connection response for given HTTP operation and parameters.

Internal: Applications should not call this method.

Parameters:

httpMethod - e.g GET/PUT/POST etc

path - path component of a hierarchical URI

urlQueryString - urlQuery without ? (question mark) for the query, values of query should be encoded

fixedHeaders - supported HTTPHeaders

userProvidedHeaders - used provided HTTPHeaders

requestBody - Stream in case of e.g PUT, POST request. null in case body is empty e.g in case of GET

contentType - Header Content-Type in case requestBody is provided

Returns:

getResponse

@Deprecated
public RestResponse getResponse(java.lang.String httpMethod,
                                            java.lang.String path,
                                            java.lang.String urlQueryString,
                                            java.util.Map<java.lang.String,java.lang.Object> fixedHeaders,
                                            byte[] requestBody,
                                            java.lang.String contentType)

Deprecated. use the version that takes map as URL query parameter

Fetches the connection response for given HTTP operation and parameters.

Internal: Applications should not call this method.

Parameters:

httpMethod - e.g GET/PUT/POST etc

path - path component of a hierarchical URI

urlQueryString - urlQuery without ? (question mark) for the query, values of query should be encoded

fixedHeaders - supported HTTPHeaders

requestBody - Stream in case of e.g PUT, POST request. null in case body is empty e.g in case of GET

contentType - Header Content-Type in case requestBody is provided

Returns:

getResponse

public RestResponse getResponse(java.lang.String httpMethod,
                                java.lang.String path,
                                java.util.Map<java.lang.String,java.lang.String> urlQueryMap,
                                java.util.Map<java.lang.String,java.lang.Object> fixedHeaders,
                                byte[] requestBody,
                                java.lang.String contentType)
                         throws java.net.URISyntaxException,
                                java.net.MalformedURLException

Fetches the connection response for given HTTP operation and parameters.

Parameters:

restConn -

httpMethod - e.g GET/PUT/POST etc. If null is passed, then HTTP GET call is made

path - path component of a hierarchical URI

urlQueryMap - Key Value pair for url query Map with non null key.

fixedHeaders - supported HTTPHeaders

requestBody - Stream in case of e.g PUT, POST request. null in case body is empty e.g in case of GET

contentType - Header Content-Type in case requestBody is provided

Returns:

Throws:

java.net.URISyntaxException

java.net.MalformedURLException

getURL

public java.net.URL getURL()

Returns the URL associated with the connection

Returns:

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

Timeout interval in milliseconds If 0 then an interval of infinity is declared.

Parameters:

timeout -

setADFBCMode

@Deprecated
public void setADFBCMode(boolean adfbcMode)

Deprecated.

adfBCMode is true by default. What this means is when an OWSM policy is attached to connection, the "describe" url from end of URL will be stripped off and resource pattern will be created/policy will be saved. User should not worry of this mode until they are creating a connection for non-adfbc rest and their url ends with /describe In case connection is being created with attrs and this attribute has to be set, pass BasicAttribute endpointAttr = new BasicAttribute(IS_ADFBC_MODE, Boolean.FALSE);

Internal: Applications should not call this method.

isADFBCMode

@Deprecated
public boolean isADFBCMode()

Deprecated.

getResourcePatternURL

public java.net.URL getResourcePatternURL()

Returned value is same as that of getURL() when isADFBCMode is false In case when Connection is in adfBCMode (default) then this URL strips of ending "/describe" from URL if present and returns the URL.

Returns:

getURLConnectionClassName

protected java.lang.String getURLConnectionClassName()