ClientSDKConfig (Oracle Fusion Middleware Java API Reference for Oracle Access Management Mobile and Social)

Encapsulates configuration info for clients. For example, it would contain the URI of a resource being accessed and possibly other configuration-related information.

Constructor Summary
`ClientSDKConfig()` Constructor for the configuration of the client sdk for REST services.
`ClientSDKConfig(java.lang.String serviceURI)` Constructor for the configuration of the client sdk for REST services.

Method Summary
`boolean`	`getReadTokenUsingQueryParametersFlag()` Gets the flag asscotaited with the clientsdk to deteremine whether to pass the info for the token to read/verify to be passed in using query parameters.
`java.lang.String`	`getRequestHelperClassName()` Gets the name of the underlying class that will encapsulate and make the HTTP calls to the REST service.
`java.lang.String`	`getServiceURI()` Returns the URI of the REST resource being accessed.
`void`	`setReadTokenUsingQueryParametersFlag(boolean readTokenUsingQueryParametersFlag)` Used for a feature on the authentication REST APIs which allows the read/verify token operation to pass the existing token to be verified in query parameters instead of in headers (the default behavior).
`void`	`setRequestHelperClassName(java.lang.String requestHelperClassName)` Used to change in cases like mock testing where a developer wants to use a different class from default for the request helper class.
`void`	`setServiceURI(java.lang.String serviceURI)` Sets the URI of the REST resource being accessed.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ClientSDKConfig

public ClientSDKConfig()

Constructor for the configuration of the client sdk for REST services.

ClientSDKConfig

public ClientSDKConfig(java.lang.String serviceURI)

Constructor for the configuration of the client sdk for REST services.

Parameters:: serviceURI - is the URI of the REST services that this configuration would be related to.

Method Detail

setServiceURI

public void setServiceURI(java.lang.String serviceURI)

Sets the URI of the REST resource being accessed.

Parameters:: serviceURI - is the URI of the service being accessed.

getServiceURI

public java.lang.String getServiceURI()

Returns the URI of the REST resource being accessed.

Returns:: the URI of the service being accessed.

setRequestHelperClassName

public void setRequestHelperClassName(java.lang.String requestHelperClassName)

Used to change in cases like mock testing where a developer wants to use a different class from default for the request helper class.

Parameters:: requestHelperClassName - is the class name of the underlying HTTP helper class. There is a default provided and this would only be used in very advanced cases.

getRequestHelperClassName

public java.lang.String getRequestHelperClassName()

Gets the name of the underlying class that will encapsulate and make the HTTP calls to the REST service. Used for advanced cases by underlying client helpers.

Returns:: the name of the underlying class that will encapsulate and make the HTTP calls to the REST service.

setReadTokenUsingQueryParametersFlag

public void setReadTokenUsingQueryParametersFlag(boolean readTokenUsingQueryParametersFlag)

Used for a feature on the authentication REST APIs which allows the read/verify token operation to pass the existing token to be verified in query parameters instead of in headers (the default behavior). This set method changes the clientsdk to pass the info for the token to read/verify to be passed in using query parameters.

Parameters:: readTokenUsingQueryParametersFlag - is the flag to dertermine whether to pass the info for the token to read/verify to be passed in using query aprameters.

getReadTokenUsingQueryParametersFlag

public boolean getReadTokenUsingQueryParametersFlag()

Gets the flag asscotaited with the clientsdk to deteremine whether to pass the info for the token to read/verify to be passed in using query parameters.