oracle.security.jps.service.idstore

Interface IdentityStoreService

All Superinterfaces:

JpsPersistable, OpssServiceInstance, ServiceInstance

public interface IdentityStoreService
extends OpssServiceInstance

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.opss.service.OpssServiceInstance

OpssServiceInstance.State

Nested classes/interfaces inherited from interface oracle.security.jps.service.JpsPersistable

JpsPersistable.Mode

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAllRealmNames() In case of multi realm configuration, this method returns all the realm names configured for this service otherwise it returns the default realm
IdentityEntityManager	getEntityManager() Returns the IdentityEntityManager associated with this service.
IdentityEntityManager	getEntityManager(java.lang.String realmName) In case of multi realm configuration, this method returns the IdentityEntityManager associated with this service for the given realm name.
ExtendedProperty	getExtendedProperty() Returns all the extended properties configured for this service instance
ExtendedProperty	getExtendedProperty(java.lang.String realmName) Returns all the extended properties configured for this service for the given realm name
oracle.igf.ids.IdentityDirectory	getIdentityStore() Returns the oracle.igf.ids.IdentityDirectory object associated with this service
oracle.igf.ids.IdentityDirectory	getIdentityStore(java.lang.String realmName) In case of multi realm configuration this method returns the oracle.igf.ids.IdentityDirectory associated with this service for the given realm name
oracle.security.idm.IdentityStore	getIdmStore() Returns the oracle.security.idm.IdentityStore object associated with this service
oracle.security.idm.IdentityStore	getIdmStore(java.lang.String realmName) In case of multi realm configuration this method returns the oracle.security.idm.IdentityStore associated with this service for the given realm name
IdentityStoreRoleManager	getIdStoreRoleManger() Deprecated. Use getEntityManager
IdentityStoreRoleManager	getIdStoreRoleManger(java.lang.String realmName) Deprecated. Use getEntityManager
IdentityStoreType	getIdStoreType() Returns the type of this service like OID, Active Directory etc
java.util.Map<java.lang.String,IdentityStoreType>	getIdStoreTypes() Returns the ldap server types which are the backend of this service, e.g., types like OID, Active Directory etc
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns all the properties configured for this service
java.util.Map<java.lang.String,java.lang.String>	getProperties(java.lang.String realmName) Returns all the properties configured for this service for the given realm name
java.lang.String	getRealmName() Returns the default realm associated with this service
ServiceInstanceDescriptor	getServiceInstanceDescriptor()
boolean	isMultiRealm() Returns true if this service is configured for multi realm otherwise returns false.

Methods inherited from interface oracle.security.opss.service.OpssServiceInstance

getState

Methods inherited from interface oracle.security.jps.service.ServiceInstance

accept, getName, getServiceProvider

Methods inherited from interface oracle.security.jps.service.JpsPersistable

persist, refresh

Method Detail

getIdmStore

oracle.security.idm.IdentityStore getIdmStore()
                                              throws IdentityStoreException

Returns the oracle.security.idm.IdentityStore object associated with this service

Returns:

oracle.security.idm.IdentityStore object associated with this service

Throws:

IdentityStoreException - if not able to find the oracle.security.idm.IdentityStore

getIdmStore

oracle.security.idm.IdentityStore getIdmStore(java.lang.String realmName)
                                              throws IdentityStoreException

In case of multi realm configuration this method returns the oracle.security.idm.IdentityStore associated with this service for the given realm name

Parameters:

realmName - the realm name to get the oracle.security.idm.IdentityStore object

Returns:

oracle.security.idm.IdentityStore object associated with this service for the given realm name

Throws:

IdentityStoreException - if not able to find the oracle.security.idm.IdentityStore

getRealmName

java.lang.String getRealmName()

Returns the default realm associated with this service

Returns:

default realm associated with this service

getAllRealmNames

java.lang.String[] getAllRealmNames()

In case of multi realm configuration, this method returns all the realm names configured for this service otherwise it returns the default realm

Returns:

all the realm names configured for this service

getIdStoreType

IdentityStoreType getIdStoreType()

Returns the type of this service like OID, Active Directory etc

Returns:

the type of this service

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns all the properties configured for this service

Returns:

properties configured for this service

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties(java.lang.String realmName)

Returns all the properties configured for this service for the given realm name

Parameters:

realmName - the realm name to get the properties

Returns:

properties configured for this service for the given realm name

getExtendedProperty

ExtendedProperty getExtendedProperty()

Returns all the extended properties configured for this service instance

Returns:

extended properties configured for this service instance

getExtendedProperty

ExtendedProperty getExtendedProperty(java.lang.String realmName)

Returns all the extended properties configured for this service for the given realm name

Parameters:

realmName - the realm name to get the extended properties

Returns:

extended properties configured for this service for the given realm name

getEntityManager

IdentityEntityManager getEntityManager()
                                       throws IdentityStoreException

Returns the IdentityEntityManager associated with this service. The IdentityEntityManager currently is for internal use only

Returns:

IdentityEntityManager associated with this service

Throws:

IdentityStoreException - if not able to find the IdentityEntityManager for this service

getEntityManager

IdentityEntityManager getEntityManager(java.lang.String realmName)
                                       throws IdentityStoreException

In case of multi realm configuration, this method returns the IdentityEntityManager associated with this service for the given realm name. The IdentityEntityManager currently is for internal use only

Parameters:

realmName - the realm name to get the IdentityEntityManager

Returns:

IdentityEntityManager associated with this service for the given realm name

Throws:

IdentityStoreException - if not able to find the IdentityEntityManager for this service

isMultiRealm

boolean isMultiRealm()

Returns true if this service is configured for multi realm otherwise returns false.

Returns:

true if this service is configured for multi realm otherwise returns false

getServiceInstanceDescriptor

ServiceInstanceDescriptor getServiceInstanceDescriptor()

Returns:

the ServiceInstanceDescriptor for this Service

getIdStoreRoleManger

@Deprecated
IdentityStoreRoleManager getIdStoreRoleManger()
                                              throws IdentityStoreException

Deprecated. Use getEntityManager

This method is deprecated. Use getEntityManager instead.

Returns:

IdentityStoreRoleManager

Throws:

IdentityStoreException - if there is an eror

See Also:

getEntityManager

getIdStoreRoleManger

@Deprecated
IdentityStoreRoleManager getIdStoreRoleManger(java.lang.String realmName)
                                              throws IdentityStoreException

Deprecated. Use getEntityManager

This method is deprecated. Use getEntityManager instead.

Parameters:

realmName - The realm name

Returns:

IdentityStoreRoleManager

Throws:

IdentityStoreException - if there is an eror

See Also:

getEntityManager

getIdStoreTypes

java.util.Map<java.lang.String,IdentityStoreType> getIdStoreTypes()

Returns the ldap server types which are the backend of this service, e.g., types like OID, Active Directory etc

Returns:

the ldap types which are the backend of this service

getIdentityStore

oracle.igf.ids.IdentityDirectory getIdentityStore()
                                                  throws IdentityStoreException

Returns the oracle.igf.ids.IdentityDirectory object associated with this service

Returns:

oracle.igf.ids.IdentityDirectory object associated with this service

Throws:

IdentityStoreException - if not able to find the oracle.igf.ids.IdentityDirectory

getIdentityStore

oracle.igf.ids.IdentityDirectory getIdentityStore(java.lang.String realmName)
                                                  throws IdentityStoreException

In case of multi realm configuration this method returns the oracle.igf.ids.IdentityDirectory associated with this service for the given realm name

Parameters:

realmName - the realm name to get the oracle.igf.ids.IdentityDirectory object

Returns:

oracle.igf.ids.IdentityDirectory object associated with this service for the given realm name

Throws:

IdentityStoreException - if not able to find the oracle.igf.ids.IdentityDirectory