Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


oracle.idm.provisioning.configuration
Class Application

java.lang.Object
  extended by oracle.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

Constructor Summary
Application(javax.naming.ldap.LdapContext lCtx, ApplicationType appType, javax.naming.directory.Attributes attrs)
          Creates an application object using the given JNDI attribtues
Application(java.lang.String appName, java.lang.String appType)
          Create an application instance object with no initial configuration information

 

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.
 void disable(javax.naming.ldap.LdapContext lCtx)
           
 void enable(javax.naming.ldap.LdapContext lCtx)
           
 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()
          Deprecated. This method will be removed in LDAP_10.1.2OCS_SOLARIS_041224 label onwards
 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.Object getPluginInstance(javax.naming.ldap.LdapContext lCtx, java.lang.String pName)
          Returns the Plugin instance identified by the given name
 java.lang.String getPolicy()
          Return default provisioning policy for this application.
 java.lang.String getProvStatusAttr()
           
 java.lang.String getProvStatusAttrName(boolean nameAndType)
          Return the provisioning Status Attribute of the application to the caller
 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
 boolean isUserApplicationAdmin(javax.naming.ldap.LdapContext ctx, IdmUser user)
          Determiines whether the IDMuser object given is an admin user in a given Directory context
static void main(java.lang.String[] args)
           
 void modifyDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name, ModPropertySet mpSet)
          Edit a Default set.
 void refreshAttrDefValCache(javax.naming.ldap.LdapContext lCtx)
          Refresh this application alone Type and Instance
 void setCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx, java.lang.String defSetName)
          Set the current default set name
 void setDefaultAttrs(javax.naming.ldap.LdapContext lCtx, ModPropertySet pmods)
          Set the defaults for the configured attributes.
 void setPolicy(javax.naming.ldap.LdapContext lCtx, java.lang.String defPolicy)
          Set the provisoining policy
 void setScheduleInterval(javax.naming.ldap.LdapContext lCtx, long interval)
           
 java.lang.String toString()
          String representation of the application object.

 

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

 

Constructor Detail

Application

public Application(javax.naming.ldap.LdapContext lCtx,
                   ApplicationType appType,
                   javax.naming.directory.Attributes attrs)
            throws java.lang.Exception
Creates an application object using the given JNDI attribtues
Parameters:
lCtx - reference to a valid Ldap context
attrs - a list of JNDI Attributes that contains application configuration information.
Throws:
java.lang.Exception

Application

public Application(java.lang.String appName,
                   java.lang.String appType)
Create an application instance object with no initial configuration information
Parameters:
appName - Application instance name
appType - Application type

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

setPolicy

public void setPolicy(javax.naming.ldap.LdapContext lCtx,
                      java.lang.String defPolicy)
               throws java.lang.Exception
Set the provisoining policy
Throws:
java.lang.Exception

isEnabled

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

disable

public void disable(javax.naming.ldap.LdapContext lCtx)
             throws java.lang.Exception
Throws:
java.lang.Exception

enable

public void enable(javax.naming.ldap.LdapContext lCtx)
            throws java.lang.Exception
Throws:
java.lang.Exception

getScheduleInterval

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

setScheduleInterval

public void setScheduleInterval(javax.naming.ldap.LdapContext lCtx,
                                long interval)
                         throws java.lang.Exception
Throws:
java.lang.Exception

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()
                                   throws java.lang.Exception
Deprecated. This method will be removed in LDAP_10.1.2OCS_SOLARIS_041224 label onwards
Get the list of attribute configurations. The attribute configuration is returned from the cache if it is available otherwise null will be returned.
Returns:
an array of attribute configuration
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

getPluginInstance

public java.lang.Object getPluginInstance(javax.naming.ldap.LdapContext lCtx,
                                          java.lang.String pName)
                                   throws java.lang.Exception
Returns the Plugin instance identified by the given name
Parameters:
pName - plugin name
Object - the plugin instance
Throws:
java.lang.Exception

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

getProvStatusAttrName

public java.lang.String getProvStatusAttrName(boolean nameAndType)
Return the provisioning Status Attribute of the application to the caller
Returns:
a String that is the attribute name of the provisioning status attribute.

setDefaultAttrs

public void setDefaultAttrs(javax.naming.ldap.LdapContext lCtx,
                            ModPropertySet pmods)
                     throws java.lang.Exception
Set the defaults for the configured attributes. If a Plugin is configured then it will be invoked otherwise ApplicationTypesetDefaultAttrs will be invoked.
Parameters:
lCtx - Ldap directory context
pmonds - a list of attribute name and value pairs
Throws:
java.lang.Exception

refreshAttrDefValCache

public void refreshAttrDefValCache(javax.naming.ldap.LdapContext lCtx)
                            throws java.lang.Exception
Refresh this application alone Type and Instance
Throws:
java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
Throws:
java.lang.Exception

toString

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

getProvStatusAttr

public java.lang.String getProvStatusAttr()

equals

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

isUserApplicationAdmin

public boolean isUserApplicationAdmin(javax.naming.ldap.LdapContext ctx,
                                      IdmUser user)
Determiines whether the IDMuser object given is an admin user in a given Directory context
Parameters:
ctx - - DirectoryContext
user - - IdmUser
Returns:

Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


Copyright © 1999, 2009 Oracle. All Rights Reserved.