Package oracle.iam.platform

Class OIMClient

java.lang.Object

oracle.iam.platform.OIMClient

public class OIMClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPSERVER_TYPE_WEBLOGIC
static final String	JAVA_NAMING_FACTORY_INITIAL
static final String	JAVA_NAMING_PROVIDER_URL
static final String	WLS_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor	Description
OIMClient()
OIMClient(Hashtable env)	Creates an instance of OIMClient to communicate with the OIM app

Method Summary

Modifier and Type	Method	Description
<T> T	getService(Class<T> serviceClass)	Returns a handle to a servics that exposed by OIM such as UserManager, RequestService, tcProvisioningOperationsIntf, ...
<T> T	getService(Class<T> serviceClass, String userLogin, char[] password)	Returns a handle to a services that exposed by OIM such as UserManager, RequestService, tcProvisioningOperationsIntf, ...
List<oracle.iam.platform.Role>	login(String username, char[] password)	Logs in to OIM on using credentials provided.
List<oracle.iam.platform.Role>	login(String username, char[] password, Hashtable configEnv)	Logs in to OIM on basis of parameters and environment supplied.
List<oracle.iam.platform.Role>	login(String username, String password)	Deprecated.
List<oracle.iam.platform.Role>	login(String username, String password, Hashtable configEnv)	Deprecated.
void	logout()	Method to destroy the login session

Methods inherited from class java.lang.Object

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

Field Details

WLS_CONTEXT_FACTORY

public static final String WLS_CONTEXT_FACTORY

See Also:

• Constant Field Values

JAVA_NAMING_PROVIDER_URL

public static final String JAVA_NAMING_PROVIDER_URL

See Also:

• Constant Field Values

JAVA_NAMING_FACTORY_INITIAL

public static final String JAVA_NAMING_FACTORY_INITIAL

See Also:

• Constant Field Values

APPSERVER_TYPE_WEBLOGIC

public static final String APPSERVER_TYPE_WEBLOGIC

See Also:

• Constant Field Values

Constructor Details

OIMClient

public OIMClient(Hashtable env)

Creates an instance of OIMClient to communicate with the OIM app

Parameters:

env - environment used to connect to the OIM application

OIMClient

public OIMClient()

Method Details

login

@Deprecated
public List<oracle.iam.platform.Role> login(String username,
 String password)
                                     throws LoginException

Deprecated.

This method has been deprecated as it requires Password in String format, which may introduce security issue.

Throws:

LoginException

login

public List<oracle.iam.platform.Role> login(String username,
 char[] password)
                                     throws LoginException

Logs in to OIM on using credentials provided.

Parameters:

username - OIM user login

password - OIM user password

Returns:

Roles returned here are not users enterprise roles. Don't use these roles

Throws:

LoginException - If there is an error during login

login

public List<oracle.iam.platform.Role> login(String username,
 char[] password,
 Hashtable configEnv)
                                     throws LoginException

Logs in to OIM on basis of parameters and environment supplied. In case any environment details are not supplied, LoginException is thrown asking for additional parameters.

Parameters:

username - OIM user login

password - OIM user password

configEnv - hashtable containing OIM server environment details

Returns:

Roles returned here are not users enterprise roles. Don't use these roles

Throws:

LoginException - If there is an error during login

login

@Deprecated
public List<oracle.iam.platform.Role> login(String username,
 String password,
 Hashtable configEnv)
                                     throws LoginException

Deprecated.

This method has been deprecated as it requires Password in String format, which may introduce security issue.

Throws:

LoginException

logout

public void logout()

Method to destroy the login session

getService

public <T> T getService(Class<T> serviceClass)

Returns a handle to a servics that exposed by OIM such as UserManager, RequestService, tcProvisioningOperationsIntf, ... etc

Type Parameters:

T -

Parameters:

serviceClass -

Returns:

getService

public <T> T getService(Class<T> serviceClass,
 String userLogin,
 char[] password)

Returns a handle to a services that exposed by OIM such as UserManager, RequestService, tcProvisioningOperationsIntf, ... etc

Type Parameters:

T -

Parameters:

serviceClass -

userLogin - the userLogin for which this LoginSession is created

password - OIM user password

Returns: