|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.idm.provisioning.configuration.Application
public class Application
Represents a registered application and all its relevent configuration information.
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 |
---|
public Application(javax.naming.ldap.LdapContext lCtx, ApplicationType appType, javax.naming.directory.Attributes attrs) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextattrs
- a list of JNDI Attributes that contains application configuration information.java.lang.Exception
public Application(java.lang.String appName, java.lang.String appType)
appName
- Application instance nameappType
- Application typeMethod Detail |
---|
public boolean getIsManageDefaults()
public java.lang.String getName()
public java.lang.String getType()
public java.lang.String getDN()
public java.lang.String getGUID()
public java.lang.String getUserDataLocation()
public java.lang.String getPolicy()
public void setPolicy(javax.naming.ldap.LdapContext lCtx, java.lang.String defPolicy) throws java.lang.Exception
java.lang.Exception
public boolean isEnabled()
public void disable(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
java.lang.Exception
public void enable(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
java.lang.Exception
public long getScheduleInterval()
public void setScheduleInterval(javax.naming.ldap.LdapContext lCtx, long interval) throws java.lang.Exception
java.lang.Exception
public java.lang.String getDisplayName()
public boolean isMultipleDefaultSetsSupported(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextjava.lang.Exception
public java.lang.String[] getDefaultSetNames(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextjava.lang.Exception
public ModPropertySet getDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextname
- Default Set nameModPropertySet
object holding the default values for the requested set.java.lang.Exception
public java.lang.String getCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextjava.lang.Exception
public void setCurrentDefaultSetName(javax.naming.ldap.LdapContext lCtx, java.lang.String defSetName) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextdefSetName
- the current default set namejava.lang.Exception
public ModPropertySet getCurrentDefaultSet(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid Ldap contextModPropertySet
object holding the default values for current default set.java.lang.Exception
public void createDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name, ModPropertySet mpSet) throws java.lang.Exception
lCtx
- reference to a valid ldap contextname
- name of the default setmpSet
- a ModPropertySet
object containing attribute defaults.java.lang.Exception
public void modifyDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name, ModPropertySet mpSet) throws java.lang.Exception
lCtx
- reference to a valid ldap contextname
- name of the default setmpSet
- a ModPropertySet
object containing attribute defaults that needs to be modfied.java.lang.Exception
public void deleteDefaultSet(javax.naming.ldap.LdapContext lCtx, java.lang.String name) throws java.lang.Exception
lCtx
- reference to a valid ldap contextname
- name of the default setjava.lang.Exception
public ConfigAttribute[] getAllAttributes() throws java.lang.Exception
java.lang.Exception
public ConfigAttribute[] getAllAttributes(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- Ldap directory contextjava.lang.Exception
public ConfigAttribute[] getMandatoryAttributes(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid ldap contextjava.lang.Exception
public ConfigAttribute[] getOptionalAttributes(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid ldap contextjava.lang.Exception
public java.lang.String[] getObjectClasses()
public java.lang.Object getPluginInstance(javax.naming.ldap.LdapContext lCtx, java.lang.String pName) throws java.lang.Exception
pName
- plugin nameObject
- the plugin instancejava.lang.Exception
public ModPropertySet getAttributes(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid ldap contextjava.lang.Exception
public java.lang.String[] getAllAttributeNames(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
lCtx
- reference to a valid ldap contextjava.lang.Exception
public java.lang.String getAppID()
public java.lang.String getProvStatusAttrName(boolean nameAndType)
public void setDefaultAttrs(javax.naming.ldap.LdapContext lCtx, ModPropertySet pmods) throws java.lang.Exception
ApplicationTypesetDefaultAttrs
will be invoked.lCtx
- Ldap directory contextpmonds
- a list of attribute name and value pairsjava.lang.Exception
public void refreshAttrDefValCache(javax.naming.ldap.LdapContext lCtx) throws java.lang.Exception
java.lang.Exception
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getProvStatusAttr()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object to be comparedpublic boolean isUserApplicationAdmin(javax.naming.ldap.LdapContext ctx, IdmUser user)
ctx
- - DirectoryContextuser
- - IdmUser
|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |