Oracle Entitlements Server for Java API Reference: Interface PDPProxyClientConfiguration

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Oracle Entitlements Server for Java API Reference

com.bea.security
Interface PDPProxyClientConfiguration

All Known Implementing Classes:: AppConfig

public interface PDPProxyClientConfiguration

The PDPProxyClientConfiguration interface is a representation of the configuration of your PDPClient application. This interface would be implemented by the AppConfig object which gets passed into the security runtime instance when you initialize it. This interface mandates implementation of getters and setters for the configuration such as UID for client, transport and failover configuration. Alternatively a properties file with the name of PDPProxyClientConfiguration.properties can also be used to provide the configuration. Please check the template configuration files for syntax.

Author:: Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Field Summary
`static java.lang.String`	`TRANSPORT_TYPE_JAVA` Transport type to be used to connect to the remote PDP, of type Java SSM.
`static java.lang.String`	`TRANSPORT_TYPE_RMI` Transport type to be used to connect to the remote PDP, of typeRMI.
`static java.lang.String`	`TRANSPORT_TYPE_WS` Transport type to be used to connect to the remote PDP, of type WS SSM.

Method Summary
`java.lang.String`	`getClientUID()` Get unique ID for the PDP Client proxy.
`int`	`getFailbackTimeout()` Get Failback timeout value set.
`int`	`getFailureRetryCount()` Get maximum attempts to try before failing over to an alternate server
`java.lang.String[]`	`getPolicyDomainURLs()` Get list of policy domains, return comma seperated list of PDP URLs
`int`	`getRequestTimeout()` Get request timeout value set.
`java.lang.String`	`getServerTransport()` Get configured transport type for the PDP Client.
`java.lang.String`	`getTrustStore()` Get current trust store.
`void`	`setClientUID(java.lang.String uid)` Set unique ID for the PDP Client proxy.
`void`	`setFailbackTimeout(int ttl)` Set Failback timeout value, if the client does not have successful connection.
`void`	`setFailureRetryCount(int count)` Set maximum attempts to try before failing over to an alternate server
`void`	`setPolicyDomainURLs(java.lang.String[] urls)` Set list of policy domains, comma seperated list of PDP URLs
`void`	`setRequestTimeout(int ttl)` Set Request timeout value, if the client does not have successful connection.
`void`	`setServerTransport(java.lang.String transport)` Set transport to use, could be one of TRANSPORT_TYPE_?
`void`	`setTrustStore(java.lang.String trustStore)` Set the trust store to use, make sure to configure the url as https or rmis This configuration setting is to be used only with a remote PDP.

Field Detail

TRANSPORT_TYPE_WS

public static final java.lang.String TRANSPORT_TYPE_WS

Transport type to be used to connect to the remote PDP, of type WS SSM.

TRANSPORT_TYPE_JAVA

public static final java.lang.String TRANSPORT_TYPE_JAVA

Transport type to be used to connect to the remote PDP, of type Java SSM.

TRANSPORT_TYPE_RMI

public static final java.lang.String TRANSPORT_TYPE_RMI

Transport type to be used to connect to the remote PDP, of typeRMI.

Method Detail

setClientUID

public void setClientUID(java.lang.String uid)

Set unique ID for the PDP Client proxy.

Parameters:: uid - Unique PDPProxy Client ID

getClientUID

public java.lang.String getClientUID()

Get unique ID for the PDP Client proxy.

Returns:: uid for the client

setServerTransport

public void setServerTransport(java.lang.String transport)

Set transport to use, could be one of TRANSPORT_TYPE_? types above.

Parameters:: uid - Unique PDPProxy Client ID

getServerTransport

public java.lang.String getServerTransport()

Get configured transport type for the PDP Client.

Returns:: transport configured, could be one of TRANSPORT_TYPE_? types.

setPolicyDomainURLs

public void setPolicyDomainURLs(java.lang.String[] urls)

Set list of policy domains, comma seperated list of PDP URLs

Parameters:: rray - or list of server urls to use http://host1:port1, http://host2:port2 etc

getPolicyDomainURLs

public java.lang.String[] getPolicyDomainURLs()

Get list of policy domains, return comma seperated list of PDP URLs

Returns:: Array or list of server urls to use http://host1:port1, http://host2:port2 etc

setFailureRetryCount

public void setFailureRetryCount(int count)

Set maximum attempts to try before failing over to an alternate server

Parameters:: count - max attempts

getFailureRetryCount

public int getFailureRetryCount()

Get maximum attempts to try before failing over to an alternate server

Returns:: max attempts

setRequestTimeout

public void setRequestTimeout(int ttl)

Set Request timeout value, if the client does not have successful connection.

Parameters:: ttl - value in milli seconds

getRequestTimeout

public int getRequestTimeout()

Get request timeout value set.

Returns:: connection time out in milli seconds

setFailbackTimeout

public void setFailbackTimeout(int ttl)

Set Failback timeout value, if the client does not have successful connection.

Parameters:: ttl - value in milli seconds

getFailbackTimeout

public int getFailbackTimeout()

Get Failback timeout value set.

Returns:: connection time out in milli seconds

setTrustStore

public void setTrustStore(java.lang.String trustStore)

Set the trust store to use, make sure to configure the url as https or rmis This configuration setting is to be used only with a remote PDP.

Parameters:: trustStore - Fully qualified path for the key store

getTrustStore

public java.lang.String getTrustStore()

Get current trust store.

Returns:: trustStore Fully qualified path for the key store