oracle.iam.platform

Class OIMClient

java.lang.Object

oracle.iam.platform.OIMClient

public class OIMClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPSERVER_TYPE_WEBLOGIC
static java.lang.String	APPSERVER_TYPE_WEBSPHERE
static java.lang.String	JAVA_NAMING_FACTORY_INITIAL
static java.lang.String	JAVA_NAMING_PROVIDER_URL
static java.lang.String	WAS_CONTEXT_FACTORY
static java.lang.String	WLS_CONTEXT_FACTORY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getService(java.lang.Class serviceClass) Returns a handle to a servics that exposed by OIM such as UserManager, RequestService, tcProvisioningOperationsIntf, ...
java.util.List	login(java.lang.String username, char[] password) Logs in to OIM on using credentials provided.
java.util.List	login(java.lang.String username, char[] password, java.util.Hashtable configEnv) Logs in to OIM on basis of parameters and environment supplied.
java.util.List	login(java.lang.String username, java.lang.String password) Deprecated.
java.util.List	login(java.lang.String username, java.lang.String password, java.util.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 Detail

WLS_CONTEXT_FACTORY

public static final java.lang.String WLS_CONTEXT_FACTORY

See Also:

Constant Field Values

WAS_CONTEXT_FACTORY

public static final java.lang.String WAS_CONTEXT_FACTORY

See Also:

Constant Field Values

JAVA_NAMING_PROVIDER_URL

public static final java.lang.String JAVA_NAMING_PROVIDER_URL

See Also:

Constant Field Values

JAVA_NAMING_FACTORY_INITIAL

public static final java.lang.String JAVA_NAMING_FACTORY_INITIAL

See Also:

Constant Field Values

APPSERVER_TYPE_WEBLOGIC

public static final java.lang.String APPSERVER_TYPE_WEBLOGIC

See Also:

Constant Field Values

APPSERVER_TYPE_WEBSPHERE

public static final java.lang.String APPSERVER_TYPE_WEBSPHERE

See Also:

Constant Field Values

Constructor Detail

OIMClient

public OIMClient(java.util.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 Detail

login

@Deprecated
public java.util.List login(java.lang.String username,
                                        java.lang.String password)
                                 throws javax.security.auth.login.LoginException

Deprecated.

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

Throws:

javax.security.auth.login.LoginException

login

public java.util.List login(java.lang.String username,
                            char[] password)
                     throws javax.security.auth.login.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:

javax.security.auth.login.LoginException - If there is an error during login

login

public java.util.List login(java.lang.String username,
                            char[] password,
                            java.util.Hashtable configEnv)
                     throws javax.security.auth.login.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:

javax.security.auth.login.LoginException - If there is an error during login

login

@Deprecated
public java.util.List login(java.lang.String username,
                                        java.lang.String password,
                                        java.util.Hashtable configEnv)
                                 throws javax.security.auth.login.LoginException

Deprecated.

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

Throws:

javax.security.auth.login.LoginException

logout

public void logout()

Method to destroy the login session

getService

public java.lang.Object getService(java.lang.Class serviceClass)

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

Parameters:

serviceClass -

Returns: