oracle.tip.pc.services.identity.config

Interface BPMIdentityConfigService

All Superinterfaces:

Service

All Known Implementing Classes:

ISConfigurationService

public interface BPMIdentityConfigService
extends Service

An interface describing the Identity Service configurations This interface is implemented to provide configuration details to Identity Service. A minimum valid configuration comprises of: <ISConfiguration xmlns="http://www.oracle.com/pcbpel/identityservice/isconfig" > <configurations> <configuration realmname="myRealm" default="true"> <provider providerType="JPS" name="MyProvider" service="Identity"> <property name="jpsContextName" value="default" /> </provider> </configuration> </configurations> </ISConfiguration>

Since:

release specific (what release of product did this appear in)

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration(java.lang.String realmName) Gets IdentityService Configuration associated with a logical realm name as configured in the configurations.
java.util.Map	getConfigurations() Gets a Map of Configurations.
java.util.List<java.lang.String>	getConfiguredApplications(java.lang.String realmName) Gets List of configured application name (application id) for identity service provider.
java.lang.String	getDefaultRealmName() Gets name of default logical realm.
java.util.Set	getSupportedRealmNames() Gets set of supported logical realms as configured in the configuration file.

Methods inherited from interface oracle.tip.pc.services.common.Service

getStatus

Method Detail

getConfiguration

Configuration getConfiguration(java.lang.String realmName)
                        throws BPMIdentityException

Gets IdentityService Configuration associated with a logical realm name as configured in the configurations.

Parameters:

realmName - The name of the logical realm that is to be represented by this Configuration object.

Throws:

BPMIdentityException - If configuration is invalid or malformed.

getConfigurations

java.util.Map getConfigurations()
                         throws BPMIdentityException

Gets a Map of Configurations. The logical realm name acts as the key to the configurations.

Returns:

Map of Configurations representing the logical realms as configured in the configuration file.

Throws:

BPMIdentityException - If configuration is invalid or malformed.

getSupportedRealmNames

java.util.Set getSupportedRealmNames()
                              throws BPMIdentityException

Gets set of supported logical realms as configured in the configuration file.

Returns:

Set of names of the supported logical realms.

Throws:

BPMIdentityException - If configuration is invalid or malformed.

getConfiguredApplications

java.util.List<java.lang.String> getConfiguredApplications(java.lang.String realmName)
                                                    throws BPMIdentityException

Gets List of configured application name (application id) for identity service provider. This provider(s) is(are) the one(s) associatd with the logical realm that is passed as a parmater.

Parameters:

realmName - A logical realm name

Returns:

List of configured application id for identity service provider associated with realmName.

Throws:

BPMIdentityException - If configuration is invalid or malformed.

getDefaultRealmName

java.lang.String getDefaultRealmName()
                              throws BPMIdentityException

Gets name of default logical realm.

Returns:

Name of default realm.

Throws:

BPMIdentityException - If configuration is invalid or malformed or, no default exists.