Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


oracle.idm.provisioning.configuration
Class Application

java.lang.Object
  extended byoracle.idm.provisioning.configuration.Application

All Implemented Interfaces:
java.io.Serializable

public class Application
extends java.lang.Object
implements java.io.Serializable

Represents a registered application and all its relevent configuration information.

See Also:
Serialized Form

Method Summary
 void createDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name, ModPropertySet mpSet)
          Create a new Default Set.
 void deleteDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name)
          Delete a Default set.
 boolean equals(java.lang.Object obj)
          Returns true if the application objects name and type are same
 java.lang.String[] getAllAttributeNames(javax.naming.ldap.LdapContext lCtx)
          Return all the names of all attributes that are configured for this application from the cache.
 ConfigAttribute[] getAllAttributes(javax.naming.ldap.LdapContext lCtx)
          Get the list of attribute configurations.
 java.lang.String getAppID()
          Get the applicaton identifier
 ModPropertySet getAttributes(javax.naming.ldap.LdapContext lCtx)
          Return all the attributes that are configured for this application from the cache.
 ModPropertySet getCurrentDefaultSet(javax.naming.ldap.LdapContext lCtx)
          Retrieve the current default set.
 java.lang.String getCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx)
          Retrieve the current default set name
 ModPropertySet getDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name)
          Retrieve the default set identified by the given name
 java.lang.String[] getDefaultSetNames(javax.naming.ldap.LdapContext lCtx)
          Retrieve all Default set Names.
 java.lang.String getDisplayName()
          Display name for this application
 java.lang.String getDN()
          Return application DN
 java.lang.String getGUID()
          Return application GUID
 boolean getIsManageDefaults()
          Whether Application Defaults are to be Managed by IM .
 ConfigAttribute[] getMandatoryAttributes(javax.naming.ldap.LdapContext lCtx)
          Gets the list of mandatory attributes.
 java.lang.String getName()
          Return application name.
 java.lang.String[] getObjectClasses()
          Get the list of ObjectClasses required for creating a application specific user footprint.
 ConfigAttribute[] getOptionalAttributes(javax.naming.ldap.LdapContext lCtx)
          Gets the list of Optional Attributes.
 java.lang.String getPolicy()
          Return default provisioning policy for this application.
 long getScheduleInterval()
          Gets the Scheduling interval
 java.lang.String getType()
          Return application type.
 java.lang.String getUserDataLocation()
          Return location where the Application user data is stored.
 boolean isEnabled()
          Check if the application is enabled or not
 boolean isMultipleDefaultSetsSupported(javax.naming.ldap.LdapContext lCtx)
          Whether multiple Application Defaults are supported by the app
 void modifyDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name, ModPropertySet mpSet)
          Edit a Default set.
 void setCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx, java.lang.String defSetName)
          Set the current default set name
 java.lang.String toString()
          String representation of the application object.

 

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Method Detail

getIsManageDefaults

public boolean getIsManageDefaults()
Whether Application Defaults are to be Managed by IM .
Returns:
Whether Manage Defaults

getName

public java.lang.String getName()
Return application name.
Returns:
Application name

getType

public java.lang.String getType()
Return application type.
Returns:
Application type

getDN

public java.lang.String getDN()
Return application DN
Returns:
Application DN

getGUID

public java.lang.String getGUID()
Return application GUID
Returns:
Application type

getUserDataLocation

public java.lang.String getUserDataLocation()
Return location where the Application user data is stored.
Returns:
app user data location.

getPolicy

public java.lang.String getPolicy()
Return default provisioning policy for this application.
Returns:
default provisioning policy

isEnabled

public boolean isEnabled()
Check if the application is enabled or not
Returns:
boolean - TRUE if enabled and FALSE otherwise

getScheduleInterval

public long getScheduleInterval()
Gets the Scheduling interval
Returns:
long - scheduling interval

getDisplayName

public java.lang.String getDisplayName()
Display name for this application
Returns:
app display name

isMultipleDefaultSetsSupported

public boolean isMultipleDefaultSetsSupported(javax.naming.ldap.LdapContext lCtx)
                                       throws java.lang.Exception
Whether multiple Application Defaults are supported by the app
Parameters:
lCtx - reference to a valid Ldap context
Returns:
Whether Manage Defaults is TRUE or not
Throws:
java.lang.Exception

getDefaultSetNames

public java.lang.String[] getDefaultSetNames(javax.naming.ldap.LdapContext lCtx)
                                      throws java.lang.Exception
Retrieve all Default set Names.
Parameters:
lCtx - reference to a valid Ldap context
Returns:
an array of default set names
Throws:
java.lang.Exception

getDefaultSet

public ModPropertySet getDefaultSet(javax.naming.ldap.LdapContext lCtx,
                                    java.lang.String name)
                             throws java.lang.Exception
Retrieve the default set identified by the given name
Parameters:
lCtx - reference to a valid Ldap context
name - Default Set name
Returns:
a ModPropertySet object holding the default values for the requested set.
Throws:
java.lang.Exception

getCurrentDefaultSetName

public java.lang.String getCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx)
                                          throws java.lang.Exception
Retrieve the current default set name
Parameters:
lCtx - reference to a valid Ldap context
Returns:
String - the current default set name
Throws:
java.lang.Exception

setCurrentDefaultSetName

public void setCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx,
                                     java.lang.String defSetName)
                              throws java.lang.Exception
Set the current default set name
Parameters:
lCtx - reference to a valid Ldap context
defSetName - the current default set name
Throws:
java.lang.Exception

getCurrentDefaultSet

public ModPropertySet getCurrentDefaultSet(javax.naming.ldap.LdapContext lCtx)
                                    throws java.lang.Exception
Retrieve the current default set.
Parameters:
lCtx - reference to a valid Ldap context
Returns:
a ModPropertySet object holding the default values for current default set.
Throws:
java.lang.Exception

createDefaultSet

public void createDefaultSet(javax.naming.ldap.LdapContext lCtx,
                             java.lang.String name,
                             ModPropertySet mpSet)
                      throws java.lang.Exception
Create a new Default Set. Note - Application must support the notion of multiple default sets.
Parameters:
lCtx - reference to a valid ldap context
name - name of the default set
mpSet - a ModPropertySet object containing attribute defaults.
Throws:
java.lang.Exception

modifyDefaultSet

public void modifyDefaultSet(javax.naming.ldap.LdapContext lCtx,
                             java.lang.String name,
                             ModPropertySet mpSet)
                      throws java.lang.Exception
Edit a Default set. Note - Application must support the notion of multiple default sets.
Parameters:
lCtx - reference to a valid ldap context
name - name of the default set
mpSet - a ModPropertySet object containing attribute defaults that needs to be modfied.
Throws:
java.lang.Exception

deleteDefaultSet

public void deleteDefaultSet(javax.naming.ldap.LdapContext lCtx,
                             java.lang.String name)
                      throws java.lang.Exception
Delete a Default set. Note - Application must support the notion of multiple default sets.
Parameters:
lCtx - reference to a valid ldap context
name - name of the default set
Throws:
java.lang.Exception

getAllAttributes

public ConfigAttribute[] getAllAttributes(javax.naming.ldap.LdapContext lCtx)
                                   throws java.lang.Exception
Get the list of attribute configurations. If the attribute configuration is not in the cache then retrive it using the provided LdapContext.
Parameters:
lCtx - Ldap directory context
Returns:
an array of attribute configuration
Throws:
java.lang.Exception

getMandatoryAttributes

public ConfigAttribute[] getMandatoryAttributes(javax.naming.ldap.LdapContext lCtx)
                                         throws java.lang.Exception
Gets the list of mandatory attributes. If the attribute configuration are not cached then it is retrieved using the provided Ldap Context
Parameters:
lCtx - reference to a valid ldap context
Returns:
ConfigAttribute[] an array of ConfigAttribute objects describing the attribute configuration information
Throws:
java.lang.Exception

getOptionalAttributes

public ConfigAttribute[] getOptionalAttributes(javax.naming.ldap.LdapContext lCtx)
                                        throws java.lang.Exception
Gets the list of Optional Attributes. If the attribute configuration are not cached then it is retrieved using the provided Ldap Context
Parameters:
lCtx - reference to a valid ldap context
Returns:
ConfigAttribute[] an array of ConfigAttribute objects describing the attribute configuration information
Throws:
java.lang.Exception

getObjectClasses

public java.lang.String[] getObjectClasses()
Get the list of ObjectClasses required for creating a application specific user footprint.
Returns:
String[] - List of objectclasses

getAttributes

public ModPropertySet getAttributes(javax.naming.ldap.LdapContext lCtx)
                             throws java.lang.Exception
Return all the attributes that are configured for this application from the cache. If not found in the cache retrieve it using the provided LdapContext
Parameters:
lCtx - reference to a valid ldap context
Returns:
a mod property set containing the attribute names and their defaults(if any) as value.
Throws:
java.lang.Exception

getAllAttributeNames

public java.lang.String[] getAllAttributeNames(javax.naming.ldap.LdapContext lCtx)
                                        throws java.lang.Exception
Return all the names of all attributes that are configured for this application from the cache. If not found in the cache retrieve it using the provided Ldap Context
Parameters:
lCtx - reference to a valid ldap context
Returns:
an array containing the list of attribute names that are configured
Throws:
java.lang.Exception

getAppID

public java.lang.String getAppID()
Get the applicaton identifier
Returns:
String = Application Identifier

toString

public java.lang.String toString()
String representation of the application object.
Returns:
string representation of the application object

equals

public boolean equals(java.lang.Object obj)
Returns true if the application objects name and type are same
Parameters:
obj - the object to be compared
Returns:
true if the application object's name and type are same as this object

Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


Copyright © 1999, 2006 Oracle. All Rights Reserved.