Skip navigation links

oracle.security.fed.admin.config.mbeans
Interface AdminUtilMXBean

public interface AdminUtilMXBean

Runtime MBean that provides utility operations for administrator use.

Since:

11.1.1.1.0

Method Summary

boolean	checkRDBMSConnection(java.lang.String jndiName) Returns true if an RDBMS connection can be established from the JNDI Name provided; returns false otherwise.
boolean	checkWallet(java.lang.String wallet, java.lang.String password, java.lang.String type) Given a Base64-encoded PKCS#12 wallet or keystore, and corresponding password and keystore type, determines if the wallet or keystore is valid and the password correct.
boolean	clearRDBMSConfiguration(java.lang.String jndiName) Clears the OIF Configuration data from RDBMS
boolean	configureOAM(java.lang.String accessServerSDKDir, java.lang.String oamAdminUsername, java.lang.String oamAdminPassword, java.lang.String defaultScheme, java.lang.String authzResult, java.lang.String hostID, java.lang.String policyDomain, java.lang.String oifHostname, java.lang.String oifPort, java.lang.String oifSSLEnabled, java.lang.String userLdapDataStoreBaseDN, java.lang.String userLdapDataStorePersonObjectClass, java.lang.String userLdapDataStoreUserUniqueID, java.lang.String[][] schemesToAddOrModify, java.lang.String[] schemesToRemove) Configures Oracle Access Manager Server for Integration with Oracle Identity Federation.
java.lang.String[]	generateNewOSSOKey(java.lang.String currentKey, long currentKeyCreationTime, long keyRollover) Returns a new random key for use in Oracle Identity Federation integration with Oracle Single Sign-On.

Method Detail

checkWallet

boolean checkWallet(java.lang.String wallet,
                    java.lang.String password,
                    java.lang.String type)

Given a Base64-encoded PKCS#12 wallet or keystore, and corresponding password and keystore type, determines if the wallet or keystore is valid and the password correct. If determining the validity of a PKCS#12 wallet, the value of the type parameter should be null or the empty String.

Parameters:

wallet - A Base64-encoded PKCS#12 wallet or keystore

password - The password used to access the given wallet or keystore

type - The type of the keystore. If using a PKCS#12 wallet, the value of this parameter should be null or the empty String.

Returns:

true if the specified wallet or keystore is valid and the password correct; false otherwise.

clearRDBMSConfiguration

boolean clearRDBMSConfiguration(java.lang.String jndiName)

Clears the OIF Configuration data from RDBMS

Parameters:

jndiName - The JNDI Name referencing the DataSource pointing to the RDBMS Configuration Data Store

Returns:

true if the operation was successful; false otherwise.

configureOAM

boolean configureOAM(java.lang.String accessServerSDKDir,
                     java.lang.String oamAdminUsername,
                     java.lang.String oamAdminPassword,
                     java.lang.String defaultScheme,
                     java.lang.String authzResult,
                     java.lang.String hostID,
                     java.lang.String policyDomain,
                     java.lang.String oifHostname,
                     java.lang.String oifPort,
                     java.lang.String oifSSLEnabled,
                     java.lang.String userLdapDataStoreBaseDN,
                     java.lang.String userLdapDataStorePersonObjectClass,
                     java.lang.String userLdapDataStoreUserUniqueID,
                     java.lang.String[][] schemesToAddOrModify,
                     java.lang.String[] schemesToRemove)

Configures Oracle Access Manager Server for Integration with Oracle Identity Federation.

Parameters:

accessServerSDKDir - Location of the local directory where Access Server SDK is installed

oamAdminUsername - Username of the Oracle Access Manager Administrator

oamAdminPassword - Password of the Oracle Access Manager Administrator

defaultScheme - Default scheme to use when creating Oracle Access Manager User Session, if no other scheme can be used

authzResult - Default Authorization Result action

hostID - Name of the Oracle Access Manager Host ID to use when configuring Oracle Access Manager for Oracle Identity Federation Integration

policyDomain - Name of the Policy Domain to create in Oracle Access Manager

oifHostname - Hostname of the Oracle Identity Federation Server, as entered in the Oracle Identity Federation configuration

oifPort - Port of the OIF Server, as entered in the Oracle Identity Federation configuration

oifSSLEnabled - SSL flag of the Oracle Identity Federation Server, as entered in the Oracle Identity Federation configuration

userLdapDataStoreBaseDN - Base DN of the LDAP User Data Store

userLdapDataStorePersonObjectClass - Person Object Class of the LDAP User Data Store

userLdapDataStoreUserUniqueID - Unique User ID of the LDAP User Data Store

schemesToAddOrModify - Authentication Schemes to add or modify in the Oracle Access Manager server

schemesToRemove - Authentication Schemes to remove from the Oracle Access Manager server

Returns:

true if the operation was successful; false otherwise.

generateNewOSSOKey

java.lang.String[] generateNewOSSOKey(java.lang.String currentKey,
                                      long currentKeyCreationTime,
                                      long keyRollover)

Returns a new random key for use in Oracle Identity Federation integration with Oracle Single Sign-On.

Parameters:

currentKey - The current key

currentKeyCreationTime - The creation time of the current key, in seconds

keyRollover - The key rollover time, in seconds

Returns:

A String[] containing the following, in order: 1. encoded contents to use in Oracle Identity Federation integration with Oracle Single Sign-On, 2. the new key, as a Hex String, and 3. the creation time of the new key, in seconds

checkRDBMSConnection

boolean checkRDBMSConnection(java.lang.String jndiName)

Returns true if an RDBMS connection can be established from the JNDI Name provided; returns false otherwise.

Parameters:

jndiName - The JNDI Name created for the database.

Returns:

true if an RDBMS connection can be established from the JNDI Name provided; false otherwise.

Skip navigation links