AdminManager (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.common.BaseMain
- - oracle.ifs.common.BaseApp
  - - oracle.ifs.admin.tools.script.AdminManager

All Implemented Interfaces:

Runnable, Logger
```
public class AdminManager
extends BaseApp
```
The AdminManager.java class - colleciton of admin tasks test.

Version:

1.0

Author:

Dave Long

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessControlListAdmin`	`m_AclAdmin`
`protected Hashtable`	`m_ActiveSections`
`protected ApplicationObjectAdmin`	`m_ApplicationObjectAdmin`
`protected String`	`m_ArrayEnclosureBegin`
`protected String`	`m_ArrayEnclosureEnd`
`protected String`	`m_ArrayValueDelimiter`
`protected AttributeValueAdmin`	`m_AttributeValueAdmin`
`protected CategoryAdmin`	`m_CategoryAdmin`
`protected ClassDomainAdmin`	`m_ClassDomainAdmin`
`protected ClassObjectAdmin`	`m_ClassObjectAdmin`
`protected ContextAdmin`	`m_ContextAdmin`
`protected String[]`	`m_CurrentTokenList`
`protected String`	`m_DefaultSectionParameterDelimiter`
`protected DefinitionAdmin`	`m_DefinitionAdmin`
`protected DirectoryGroupAdmin`	`m_DirectoryGroupAdmin`
`protected DirectoryServiceAdmin`	`m_DirectoryServiceAdmin`
`protected DirectoryUserAdmin`	`m_DirectoryUserAdmin`
`protected DocumentAdmin`	`m_DocumentAdmin`
`protected boolean`	`m_ExitOnError`
`protected ExtendedPermissionAdmin`	`m_ExtendedPermissionAdmin`
`protected String`	`m_ExtendedPermissionPrefix`
`protected FamilyAdmin`	`m_FamilyAdmin`
`protected FolderAdmin`	`m_FolderAdmin`
`protected FormatAdmin`	`m_FormatAdmin`
`protected String[]`	`m_InputParamTokenList`
`protected Hashtable`	`m_InputParamTokenTable`
`protected IfsException`	`m_LastException`
`protected boolean`	`m_LastTaskSuccess`
`protected MediaAdmin`	`m_MediaAdmin`
`protected MountPointAdmin`	`m_MountPointAdmin`
`protected String`	`m_NullValueToken`
`protected String`	`m_OmitValueToken`
`protected PermissionBundleAdmin`	`m_PermissionBundleAdmin`
`protected String`	`m_PermissionBundlePrefix`
`protected PolicyAdmin`	`m_PolicyAdmin`
`protected PropertyBundleAdmin`	`m_PropertyBundleAdmin`
`protected boolean`	`m_ReturnOnError`
`protected SearchObjectAdmin`	`m_SearchObjectAdmin`
`protected String`	`m_SectionParameterDelimiter`
`protected SelectorObjectAdmin`	`m_SelectorObjectAdmin`
`protected boolean`	`m_ShowIdsInOutput`
`protected boolean`	`m_ShowStackTraces`
`protected boolean`	`m_SkipCreationIfExists`
`protected boolean`	`m_SkipFreeIfNotExists`
`protected SystemLockObjectAdmin`	`m_SystemLockObjectAdmin`
`protected Transaction`	`m_TaskTransaction`
`protected boolean`	`m_TestMode`
`protected Transaction`	`m_TestModeTransaction`
`protected boolean`	`m_TraceSections`
`protected UserProfileAdmin`	`m_UserProfileAdmin`
`protected ValueDefaultAdmin`	`m_ValueDefaultAdmin`
`protected String`	`m_ValueDelimiter`
`protected ValueDomainAdmin`	`m_ValueDomainAdmin`
`protected String`	`m_ValueFormatDelimiter`
`protected VersionDescriptionAdmin`	`m_VersionDescriptionAdmin`
`protected VersionSeriesAdmin`	`m_VersionSeriesAdmin`

Fields inherited from class oracle.ifs.common.BaseApp
m_currentuser, m_session

Fields inherited from class oracle.ifs.common.BaseMain
m_defaultWriter, m_logWriter, m_parametertable, m_timervalue

Constructor Summary

Constructors
Constructor and Description

AdminManager()
Default constructor

AdminManager(String[] args)
The only constructor that is being used.

Constructors
Constructor and Description
`AdminManager()` Default constructor
`AdminManager(String[] args)` The only constructor that is being used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addGlobalToken(String key, String string)` addGlobalToken() - add a new token to the globla table, so that it can be used via the $$ replacement syntax.
`protected void`	`ensureNotTestMode()` ensureNotTestMode() - throw an exception if in testmode
`AccessControlListAdmin`	`getAccessControlListAdmin()` get the AccessControlList admin task manager
`ApplicationObjectAdmin`	`getApplicationObjectAdmin()` get the ApplicationObject admin task manager
`AttributeValueAdmin`	`getAttributeValueAdmin()` get the AttributeValue admin task manager
`protected AttributeValue[]`	`getAVArrayFromBooleanNamedTokenArray(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getAVArrayFromBooleanNamedTokenArray() - get an AV[] from token of the form {name1 : false, name2 : true}.
`protected AttributeValue[]`	`getAVArrayFromStringNamedTokenArray(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getAVArrayFromStringNamedTokenArray() - get an AV[] from token of the form {name1 : value1, name2 : value2}.
`protected Boolean`	`getBoolean(ParameterTable params, String key)` getBoolean() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected boolean`	`getBoolean(ParameterTable params, String key, boolean defValue)` getBoolean() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected AttributeValue`	`getBooleanArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getBooleanArrayAVFromToken() - get an AV of type Boolean array from a token.
`protected AttributeValue`	`getBooleanAVFromToken(LibrarySession sess, String token, String valueDelim)` getBooleanAVFromToken() - get an AV of type Boolean from a token.
`CategoryAdmin`	`getCategoryAdmin()` get the CategoryAdmin task manager
`ClassDomainAdmin`	`getClassDomainAdmin()` get the ClassDomain admin task manager
`ClassObjectAdmin`	`getClassObjectAdmin()` get the ClassObject admin task manager
`protected AttributeValue`	`getClassObjectArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getClassObjectArrayAVFromToken() - get an AV of type ClassObject array from a token.
`ContextAdmin`	`getContextAdmin()` get the Context admin task manager
`protected AttributeValue`	`getDateArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim, String valueFormatDelim)` getDateArrayAVFromToken() - get an AV of type Date array from a token.
`protected AttributeValue`	`getDateAVFromToken(LibrarySession sess, String token, String valueDelim, String valueformatDelim)` getDateAVFromToken() - get an AV of type Date from a token.
`protected Date`	`getDateFromToken(String token, String valueformatDelim)` getDateFromToken() - get Date from a value of the form "datevalue ; dateformat".
`DefinitionAdmin`	`getDefinitionAdmin()` get the DefinitionAdmin admin task manager
`protected LibraryObjectDefinition`	`getDefinitionFromSectionParams(LibrarySession sess, ParameterTable params)` getDefinitionFromSectionParams() - returns a cloned LibraryObjectDefinition is an explicit Definition specified in the Section.
`DirectoryGroupAdmin`	`getDirectoryGroupAdmin()` get the DirectoryGroup admin task manager
`DirectoryServiceAdmin`	`getDirectoryServiceAdmin()` get the DirectoryService admin task manager
`DirectoryUserAdmin`	`getDirectoryUserAdmin()` get the DirectoryUser admin task manager
`DocumentAdmin`	`getDocumentAdmin()` get the Documentadmin task manager
`protected AttributeValue`	`getDoubleArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim, String valueFormatDelim)` getDoubleArrayAVFromToken() - get an AV of type Double array from a token.
`protected AttributeValue`	`getDoubleAVFromToken(LibrarySession sess, String token, String valueDelim, String valueformatDelim)` getDoubleAVFromToken() - get an AV of type Date from a token.
`protected Double`	`getDoubleFromToken(String token, String valueformatDelim)` getDateFromToken() - get Double from a value of the form "doublevalue ; dateformat".
`ExtendedPermissionAdmin`	`getExtendedPermissionAdmin()` get the ExtendedPermission admin task manager
`FamilyAdmin`	`getFamilyAdmin()` get the Family admin task manager
`FolderAdmin`	`getFolderAdmin()` get the Folder admin task manager
`FormatAdmin`	`getFormatAdmin()` get the Format admin task manager
`protected Integer`	`getInteger(ParameterTable params, String key)` getInteger() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected int`	`getInteger(ParameterTable params, String key, int defValue)` getInteger() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected AttributeValue`	`getIntegerArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getIntegerArrayAVFromToken() - get an AV of type Integer array from a token.
`protected AttributeValue`	`getIntegerAVFromToken(LibrarySession sess, String token, String valueDelim)` getIntegerAVFromToken() - get an AV of type Integer from a token.
`protected String`	`getLineSeparator()` getLineSeparator() - returns the new line sequence
`protected Long`	`getLong(ParameterTable params, String key)` getLong() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected long`	`getLong(ParameterTable params, String key, long defValue)` getLong() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected AttributeValue`	`getLongArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getLongArrayAVFromToken() - get an AV of type Long array from a token.
`protected AttributeValue`	`getLongAVFromToken(LibrarySession sess, String token, String valueDelim)` getLongAVFromToken() - get an AV of type Long from a token.
`MediaAdmin`	`getMediaAdmin()` get the Media admin task manager
`MountPointAdmin`	`getMountPointAdmin()` get the Mount point admin task manager
`protected String`	`getNameFromNamedToken(String token, String valueDelim)` getNameFromNamedToken() - get name from a token of the form "name : value".
`protected String`	`getNullToken()` getNullToken() - returns the current NULL token
`protected String`	`getOmitToken()` getOmitToken() - returns the current OMIT token
`PermissionBundleAdmin`	`getPermissionBundleAdmin()` get the PermissionBundle admin task manager
`PolicyAdmin`	`getPolicyAdmin()` get the Policy admin task manager
`protected AttributeValue`	`getPolicyArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getPolicyArrayAVFromToken() - get an AV of type SystemObject array from a token.
`PropertyBundleAdmin`	`getPropertyBundleAdmin()` get the PropertyBundle admin task manager
`SearchObjectAdmin`	`getSearchObjectAdmin()` get the SearchObject admin task manager
`SelectorObjectAdmin`	`getSelectorObjectAdmin()` get the SelectorObject admin task manager
`protected String`	`getString(ParameterTable params, String key)` getString() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected String`	`getString(ParameterTable params, String key, String defValue)` getString() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected AttributeValue`	`getStringArrayAVFromToken(LibrarySession sess, String token, String valueDelim, String arrayvalueDelim)` getStringArrayAVFromToken() - get an AV of type String array from a token.
`protected AttributeValue`	`getStringAVFromToken(LibrarySession sess, String token, String valueDelim)` getStringAVFromToken() - get an AV of type String from a token.
`protected String`	`getStringExposeNull(ParameterTable params, String key)` getStringExposeNull() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`String`	`getStringId(LibraryObject obj)` Get an object's Id suitable for printing to canonlog.
`protected String[]`	`getStrings(ParameterTable params, String key)` getStrings() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).
`protected String[]`	`getStringsFromArrayToken(String token, String arrayvalueDelim)` getStringsFromArrayToken() - get String array from a value of the form "{value1, value2, value3}".
`SystemLockObjectAdmin`	`getSystemLockObjectAdmin()` get the SystemLockObject admin task manager
`UserProfileAdmin`	`getUserProfileAdmin()` get the UserProfile admin task manager
`ValueDefaultAdmin`	`getValueDefaultAdmin()` get the ValueDefault admin task manager
`ValueDomainAdmin`	`getValueDomainAdmin()` get the ValueDomain admin task manager
`protected String`	`getValueFromNamedToken(String token, String valueDelim)` getValueFromNamedToken() - get value from a token of the form "name : value".
`protected String`	`getValueFromNamedTokenExposeNull(String token, String valueDelim)` getValueFromNamedTokenExposeNull() - get value from a token of the form "name : value".
`VersionDescriptionAdmin`	`getVersionDescriptionAdmin()` get the VersionDescription admin task manager
`protected VersionDescriptionDefinition`	`getVersionDescriptionDefinitionFromSectionParams(LibrarySession sess, ParameterTable params)` getVersionDescriptionDefinitionFromSectionParams() - returns a cloned VersionDescriptionDefinition if one is indicated in the section parameters, as indicated by a VersionDescriptionDefinition = xxx specification.
`VersionSeriesAdmin`	`getVersionSeriesAdmin()` get the VersionSeries admin task manager
`protected PublicObject`	`identifyPublicObject(LibrarySession sess, Long id, String name, String valueDefaultName, String path, String className, String nameAttrname)` identifyPublicObject() - method used by several PublicObject admin classes to identify an object based on one of: 1.
`protected PublicObject`	`identifyPublicObjectByPath(LibrarySession sess, String path)` identifyPublicObjectByPath() - method used by several PublicObject admin classes to identify an object based on the path of the publi object.
`protected PublicObject[]`	`identifyPublicObjects(LibrarySession sess, Long id, String name, String className, String nameAttrname)` identifyPublicObjects() - return set of PublicObjects based on: 1.
`protected boolean`	`isValueNullFromNamedToken(String token, String valueDelim)` isValueNullFromNamedToken() - return indication as to whehter a named token's value is null.
`static void`	`main(String[] args)` This method starts the Test.
`void`	`performOperation()` performOperation() - called by run() to run the script.
`protected void`	`removeGlobalToken(String key)` removeGlobalToken() - remove a token from the global table.
`protected String`	`replaceIfArgumentSpec(String string)` replaceIfArgumentSpec() - replace String with the passed-parameter value if the specified String conforms to the ArgumnetSpec syntax.
`protected String`	`replaceIfArgumentSpecExposeNull(String string)` replaceIfArgumentSpecExposeNull() - similar to replaceIfArgumentSpec but expose an explicit NULL seting as the NULL token, so that callre can distinguish between NULL and not-set.
`protected String`	`replaceWithInputParamIfArgumentSpec(String string)`
`void`	`run()`
`protected void`	`setDefinitionFromSectionParams(LibrarySession sess, ParameterTable params, LibraryObjectDefinition def)` setDefinitionFromSectionParams() - calls main variant of setDefinitionFromSectionParams with the forceNameUpper parameter set to true.
`protected void`	`setDefinitionFromSectionParams(LibrarySession sess, ParameterTable params, LibraryObjectDefinition def, boolean forceNameUpper)` setDefinitionFromSectionParams() - apply any attribuite settings and other section settings to the specified LODef.

Methods inherited from class oracle.ifs.common.BaseApp
connect, Connect, connect, Connect, Connect, Connect, connect, Connect, connect, Connect, Disconnect, getCachePerformanceString, getCleartextCredential, getCleartextCredential, getConnectionPoolPerformanceString, getConnectOptions, getConnectOptions, getConnectOptions, getLocale, showCachePerformance, showConnectionPoolPerformance

Methods inherited from class oracle.ifs.common.BaseMain
getElapsedTime, getParameterTable, initTrace, log, log, logCurrentTimestamp, printStackTrace, setTimer, showElapsedTime

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

Field Detail

m_ShowIdsInOutput
```
protected boolean m_ShowIdsInOutput
```

m_ShowStackTraces
```
protected boolean m_ShowStackTraces
```

m_TestMode
```
protected boolean m_TestMode
```

m_TestModeTransaction

protected Transaction m_TestModeTransaction

m_TaskTransaction

protected Transaction m_TaskTransaction

m_ValueDelimiter
```
protected String m_ValueDelimiter
```

m_ArrayValueDelimiter
```
protected String m_ArrayValueDelimiter
```

m_ValueFormatDelimiter

protected String m_ValueFormatDelimiter

m_SectionParameterDelimiter

protected String m_SectionParameterDelimiter

m_DefaultSectionParameterDelimiter

protected String m_DefaultSectionParameterDelimiter

m_ArrayEnclosureBegin
```
protected String m_ArrayEnclosureBegin
```

m_ArrayEnclosureEnd
```
protected String m_ArrayEnclosureEnd
```

m_PermissionBundlePrefix

protected String m_PermissionBundlePrefix

m_ExtendedPermissionPrefix

protected String m_ExtendedPermissionPrefix

m_InputParamTokenList

protected String[] m_InputParamTokenList

m_InputParamTokenTable

protected Hashtable m_InputParamTokenTable

m_CurrentTokenList
```
protected String[] m_CurrentTokenList
```

m_NullValueToken
```
protected String m_NullValueToken
```

m_OmitValueToken
```
protected String m_OmitValueToken
```

m_ActiveSections
```
protected Hashtable m_ActiveSections
```

m_LastTaskSuccess
```
protected boolean m_LastTaskSuccess
```

m_ReturnOnError
```
protected boolean m_ReturnOnError
```

m_ExitOnError
```
protected boolean m_ExitOnError
```

m_LastException
```
protected IfsException m_LastException
```

m_TraceSections
```
protected boolean m_TraceSections
```

m_SkipCreationIfExists

protected boolean m_SkipCreationIfExists

m_SkipFreeIfNotExists

protected boolean m_SkipFreeIfNotExists

m_AclAdmin

protected AccessControlListAdmin m_AclAdmin

m_ApplicationObjectAdmin

protected ApplicationObjectAdmin m_ApplicationObjectAdmin

m_AttributeValueAdmin

protected AttributeValueAdmin m_AttributeValueAdmin

m_CategoryAdmin

protected CategoryAdmin m_CategoryAdmin

m_ClassDomainAdmin

protected ClassDomainAdmin m_ClassDomainAdmin

m_ClassObjectAdmin

protected ClassObjectAdmin m_ClassObjectAdmin

m_ContextAdmin
```
protected ContextAdmin m_ContextAdmin
```

m_DefinitionAdmin

protected DefinitionAdmin m_DefinitionAdmin

m_DirectoryServiceAdmin

protected DirectoryServiceAdmin m_DirectoryServiceAdmin

m_DirectoryUserAdmin

protected DirectoryUserAdmin m_DirectoryUserAdmin

m_DirectoryGroupAdmin

protected DirectoryGroupAdmin m_DirectoryGroupAdmin

m_DocumentAdmin

protected DocumentAdmin m_DocumentAdmin

m_ExtendedPermissionAdmin

protected ExtendedPermissionAdmin m_ExtendedPermissionAdmin

m_FamilyAdmin
```
protected FamilyAdmin m_FamilyAdmin
```

m_FolderAdmin
```
protected FolderAdmin m_FolderAdmin
```

m_FormatAdmin
```
protected FormatAdmin m_FormatAdmin
```

m_MediaAdmin
```
protected MediaAdmin m_MediaAdmin
```

m_MountPointAdmin

protected MountPointAdmin m_MountPointAdmin

m_PermissionBundleAdmin

protected PermissionBundleAdmin m_PermissionBundleAdmin

m_PropertyBundleAdmin

protected PropertyBundleAdmin m_PropertyBundleAdmin

m_PolicyAdmin
```
protected PolicyAdmin m_PolicyAdmin
```

m_SearchObjectAdmin

protected SearchObjectAdmin m_SearchObjectAdmin

m_SelectorObjectAdmin

protected SelectorObjectAdmin m_SelectorObjectAdmin

m_SystemLockObjectAdmin

protected SystemLockObjectAdmin m_SystemLockObjectAdmin

m_UserProfileAdmin

protected UserProfileAdmin m_UserProfileAdmin

m_ValueDefaultAdmin

protected ValueDefaultAdmin m_ValueDefaultAdmin

m_ValueDomainAdmin

protected ValueDomainAdmin m_ValueDomainAdmin

m_VersionDescriptionAdmin

protected VersionDescriptionAdmin m_VersionDescriptionAdmin

m_VersionSeriesAdmin

protected VersionSeriesAdmin m_VersionSeriesAdmin

Constructor Detail
- AdminManager
```
public AdminManager(String[] args)
```
  The only constructor that is being used.
  
  Parameters:
  
  args - commandline arguments
- AdminManager
```
public AdminManager()
```
  Default constructor

Method Detail

main
```
public static void main(String[] args)
```
This method starts the Test.

Parameters:

args - the test arguments.

run
```
public void run()
```

getStringId
```
public String getStringId(LibraryObject obj)
                   throws IfsException
```
Get an object's Id suitable for printing to canonlog.

Parameters:

obj - Requested object.

Throws:

IfsException

getAccessControlListAdmin
```
public AccessControlListAdmin getAccessControlListAdmin()
```
get the AccessControlList admin task manager

getApplicationObjectAdmin
```
public ApplicationObjectAdmin getApplicationObjectAdmin()
```
get the ApplicationObject admin task manager

getAttributeValueAdmin
```
public AttributeValueAdmin getAttributeValueAdmin()
```
get the AttributeValue admin task manager

getCategoryAdmin
```
public CategoryAdmin getCategoryAdmin()
```
get the CategoryAdmin task manager

getClassDomainAdmin
```
public ClassDomainAdmin getClassDomainAdmin()
```
get the ClassDomain admin task manager

getClassObjectAdmin
```
public ClassObjectAdmin getClassObjectAdmin()
```
get the ClassObject admin task manager

getContextAdmin
```
public ContextAdmin getContextAdmin()
```
get the Context admin task manager

getDefinitionAdmin
```
public DefinitionAdmin getDefinitionAdmin()
```
get the DefinitionAdmin admin task manager

getDirectoryGroupAdmin
```
public DirectoryGroupAdmin getDirectoryGroupAdmin()
```
get the DirectoryGroup admin task manager

getDirectoryUserAdmin
```
public DirectoryUserAdmin getDirectoryUserAdmin()
```
get the DirectoryUser admin task manager

getDirectoryServiceAdmin
```
public DirectoryServiceAdmin getDirectoryServiceAdmin()
```
get the DirectoryService admin task manager

getDocumentAdmin
```
public DocumentAdmin getDocumentAdmin()
```
get the Documentadmin task manager

getExtendedPermissionAdmin
```
public ExtendedPermissionAdmin getExtendedPermissionAdmin()
```
get the ExtendedPermission admin task manager

getFamilyAdmin
```
public FamilyAdmin getFamilyAdmin()
```
get the Family admin task manager

getFolderAdmin
```
public FolderAdmin getFolderAdmin()
```
get the Folder admin task manager

getFormatAdmin
```
public FormatAdmin getFormatAdmin()
```
get the Format admin task manager

getMediaAdmin
```
public MediaAdmin getMediaAdmin()
```
get the Media admin task manager

getMountPointAdmin
```
public MountPointAdmin getMountPointAdmin()
```
get the Mount point admin task manager

getPermissionBundleAdmin
```
public PermissionBundleAdmin getPermissionBundleAdmin()
```
get the PermissionBundle admin task manager

getPolicyAdmin
```
public PolicyAdmin getPolicyAdmin()
```
get the Policy admin task manager

getPropertyBundleAdmin
```
public PropertyBundleAdmin getPropertyBundleAdmin()
```
get the PropertyBundle admin task manager

getSearchObjectAdmin
```
public SearchObjectAdmin getSearchObjectAdmin()
```
get the SearchObject admin task manager

getSelectorObjectAdmin
```
public SelectorObjectAdmin getSelectorObjectAdmin()
```
get the SelectorObject admin task manager

getSystemLockObjectAdmin
```
public SystemLockObjectAdmin getSystemLockObjectAdmin()
```
get the SystemLockObject admin task manager

getUserProfileAdmin
```
public UserProfileAdmin getUserProfileAdmin()
```
get the UserProfile admin task manager

getValueDefaultAdmin
```
public ValueDefaultAdmin getValueDefaultAdmin()
```
get the ValueDefault admin task manager

getValueDomainAdmin
```
public ValueDomainAdmin getValueDomainAdmin()
```
get the ValueDomain admin task manager

getVersionDescriptionAdmin
```
public VersionDescriptionAdmin getVersionDescriptionAdmin()
```
get the VersionDescription admin task manager

getVersionSeriesAdmin
```
public VersionSeriesAdmin getVersionSeriesAdmin()
```
get the VersionSeries admin task manager

performOperation
```
public void performOperation()
                      throws IfsException
```
performOperation() - called by run() to run the script. This can also be called directly.

Throws:

IfsException

getDefinitionFromSectionParams

protected LibraryObjectDefinition getDefinitionFromSectionParams(LibrarySession sess,
                                                                 ParameterTable params)
                                                          throws IfsException

getDefinitionFromSectionParams() - returns a cloned LibraryObjectDefinition is an explicit Definition specified in the Section.

Throws:: IfsException

getVersionDescriptionDefinitionFromSectionParams

protected VersionDescriptionDefinition getVersionDescriptionDefinitionFromSectionParams(LibrarySession sess,
                                                                                        ParameterTable params)
                                                                                 throws IfsException

getVersionDescriptionDefinitionFromSectionParams() - returns a cloned VersionDescriptionDefinition if one is indicated in the section parameters, as indicated by a VersionDescriptionDefinition = xxx specification. This is used to create versionable objects.

Throws:: IfsException

setDefinitionFromSectionParams

protected void setDefinitionFromSectionParams(LibrarySession sess,
                                              ParameterTable params,
                                              LibraryObjectDefinition def)
                                       throws IfsException

setDefinitionFromSectionParams() - calls main variant of setDefinitionFromSectionParams with the forceNameUpper parameter set to true.

Throws:: IfsException

setDefinitionFromSectionParams

protected void setDefinitionFromSectionParams(LibrarySession sess,
                                              ParameterTable params,
                                              LibraryObjectDefinition def,
                                              boolean forceNameUpper)
                                       throws IfsException

setDefinitionFromSectionParams() - apply any attribuite settings and other section settings to the specified LODef.

Throws:: IfsException

getStringAVFromToken

protected AttributeValue getStringAVFromToken(LibrarySession sess,
                                              String token,
                                              String valueDelim)
                                       throws IfsException

getStringAVFromToken() - get an AV of type String from a token.

Throws:: IfsException

getBooleanAVFromToken

protected AttributeValue getBooleanAVFromToken(LibrarySession sess,
                                               String token,
                                               String valueDelim)
                                        throws IfsException

getBooleanAVFromToken() - get an AV of type Boolean from a token.

Throws:: IfsException

getIntegerAVFromToken

protected AttributeValue getIntegerAVFromToken(LibrarySession sess,
                                               String token,
                                               String valueDelim)
                                        throws IfsException

getIntegerAVFromToken() - get an AV of type Integer from a token.

Throws:: IfsException

getLongAVFromToken

protected AttributeValue getLongAVFromToken(LibrarySession sess,
                                            String token,
                                            String valueDelim)
                                     throws IfsException

getLongAVFromToken() - get an AV of type Long from a token.

Throws:: IfsException

getDoubleAVFromToken

protected AttributeValue getDoubleAVFromToken(LibrarySession sess,
                                              String token,
                                              String valueDelim,
                                              String valueformatDelim)
                                       throws IfsException

getDoubleAVFromToken() - get an AV of type Date from a token.

Throws:: IfsException

getDateAVFromToken

protected AttributeValue getDateAVFromToken(LibrarySession sess,
                                            String token,
                                            String valueDelim,
                                            String valueformatDelim)
                                     throws IfsException

getDateAVFromToken() - get an AV of type Date from a token.

Throws:: IfsException

getStringArrayAVFromToken

protected AttributeValue getStringArrayAVFromToken(LibrarySession sess,
                                                   String token,
                                                   String valueDelim,
                                                   String arrayvalueDelim)
                                            throws IfsException

getStringArrayAVFromToken() - get an AV of type String array from a token.

Throws:: IfsException

getBooleanArrayAVFromToken

protected AttributeValue getBooleanArrayAVFromToken(LibrarySession sess,
                                                    String token,
                                                    String valueDelim,
                                                    String arrayvalueDelim)
                                             throws IfsException

getBooleanArrayAVFromToken() - get an AV of type Boolean array from a token.

Throws:: IfsException

getIntegerArrayAVFromToken

protected AttributeValue getIntegerArrayAVFromToken(LibrarySession sess,
                                                    String token,
                                                    String valueDelim,
                                                    String arrayvalueDelim)
                                             throws IfsException

getIntegerArrayAVFromToken() - get an AV of type Integer array from a token.

Throws:: IfsException

getLongArrayAVFromToken

protected AttributeValue getLongArrayAVFromToken(LibrarySession sess,
                                                 String token,
                                                 String valueDelim,
                                                 String arrayvalueDelim)
                                          throws IfsException

getLongArrayAVFromToken() - get an AV of type Long array from a token.

Throws:: IfsException

getDoubleArrayAVFromToken

protected AttributeValue getDoubleArrayAVFromToken(LibrarySession sess,
                                                   String token,
                                                   String valueDelim,
                                                   String arrayvalueDelim,
                                                   String valueFormatDelim)
                                            throws IfsException

getDoubleArrayAVFromToken() - get an AV of type Double array from a token.

Throws:: IfsException

getDateArrayAVFromToken

protected AttributeValue getDateArrayAVFromToken(LibrarySession sess,
                                                 String token,
                                                 String valueDelim,
                                                 String arrayvalueDelim,
                                                 String valueFormatDelim)
                                          throws IfsException

getDateArrayAVFromToken() - get an AV of type Date array from a token.

Throws:: IfsException

getClassObjectArrayAVFromToken

protected AttributeValue getClassObjectArrayAVFromToken(LibrarySession sess,
                                                        String token,
                                                        String valueDelim,
                                                        String arrayvalueDelim)
                                                 throws IfsException

getClassObjectArrayAVFromToken() - get an AV of type ClassObject array from a token.

Throws:: IfsException

getPolicyArrayAVFromToken

protected AttributeValue getPolicyArrayAVFromToken(LibrarySession sess,
                                                   String token,
                                                   String valueDelim,
                                                   String arrayvalueDelim)
                                            throws IfsException

getPolicyArrayAVFromToken() - get an AV of type SystemObject array from a token.

Throws:: IfsException

getAVArrayFromStringNamedTokenArray

protected AttributeValue[] getAVArrayFromStringNamedTokenArray(LibrarySession sess,
                                                               String token,
                                                               String valueDelim,
                                                               String arrayvalueDelim)
                                                        throws IfsException

getAVArrayFromStringNamedTokenArray() - get an AV[] from token of the form {name1 : value1, name2 : value2}. The AV's will be of type String, and have the name that matches the names in the tokens.

Throws:: IfsException

getAVArrayFromBooleanNamedTokenArray

protected AttributeValue[] getAVArrayFromBooleanNamedTokenArray(LibrarySession sess,
                                                                String token,
                                                                String valueDelim,
                                                                String arrayvalueDelim)
                                                         throws IfsException

getAVArrayFromBooleanNamedTokenArray() - get an AV[] from token of the form {name1 : false, name2 : true}. The AV's will be of type boolean, and have the name that matches the names in the tokens.

Throws:: IfsException

getNullToken
```
protected String getNullToken()
```
getNullToken() - returns the current NULL token

getOmitToken
```
protected String getOmitToken()
```
getOmitToken() - returns the current OMIT token

getLineSeparator
```
protected String getLineSeparator()
```
getLineSeparator() - returns the new line sequence

ensureNotTestMode
```
protected void ensureNotTestMode()
                          throws IfsException
```
ensureNotTestMode() - throw an exception if in testmode

Throws:

IfsException

getString

protected String getString(ParameterTable params,
                           String key)

getString() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

getStringExposeNull

protected String getStringExposeNull(ParameterTable params,
                                     String key)

getStringExposeNull() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

replaceWithInputParamIfArgumentSpec

protected String replaceWithInputParamIfArgumentSpec(String string)

getString

protected String getString(ParameterTable params,
                           String key,
                           String defValue)

getString() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec). This variant has a default value if no value is specified.

getStrings

protected String[] getStrings(ParameterTable params,
                              String key)

getStrings() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

getBoolean

protected Boolean getBoolean(ParameterTable params,
                             String key)

getBoolean() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

getBoolean
```
protected boolean getBoolean(ParameterTable params,
                             String key,
                             boolean defValue)
```
getBoolean() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec). This variant has a default value if no value is specified.

getInteger

protected Integer getInteger(ParameterTable params,
                             String key)

getInteger() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

getInteger
```
protected int getInteger(ParameterTable params,
                         String key,
                         int defValue)
```
getInteger() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec). This variant has a default value if no value is specified.

getLong
```
protected Long getLong(ParameterTable params,
                       String key)
```
getLong() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec).

getLong
```
protected long getLong(ParameterTable params,
                       String key,
                       long defValue)
```
getLong() - ParameterTable-like method, that also replaces the value if it's an ArgumentSpec (i.e. a $$n spec). This variant has a default value if no value is specified.

replaceIfArgumentSpec
```
protected String replaceIfArgumentSpec(String string)
```
replaceIfArgumentSpec() - replace String with the passed-parameter value if the specified String conforms to the ArgumnetSpec syntax.

replaceIfArgumentSpecExposeNull
```
protected String replaceIfArgumentSpecExposeNull(String string)
```
replaceIfArgumentSpecExposeNull() - similar to replaceIfArgumentSpec but expose an explicit NULL seting as the NULL token, so that callre can distinguish between NULL and not-set.

addGlobalToken

protected void addGlobalToken(String key,
                              String string)

addGlobalToken() - add a new token to the globla table, so that it can be used via the $$ replacement syntax.

removeGlobalToken

protected void removeGlobalToken(String key)
                          throws IfsException

removeGlobalToken() - remove a token from the global table.

Throws:: IfsException

getNameFromNamedToken

protected String getNameFromNamedToken(String token,
                                       String valueDelim)
                                throws IfsException

getNameFromNamedToken() - get name from a token of the form "name : value".

Throws:: IfsException

isValueNullFromNamedToken

protected boolean isValueNullFromNamedToken(String token,
                                            String valueDelim)
                                     throws IfsException

isValueNullFromNamedToken() - return indication as to whehter a named token's value is null. Do not return true if the value is omitted (with empty string or expicit OMIT token).

Throws:: IfsException

getValueFromNamedToken

protected String getValueFromNamedToken(String token,
                                        String valueDelim)
                                 throws IfsException

getValueFromNamedToken() - get value from a token of the form "name : value".

Throws:: IfsException

getValueFromNamedTokenExposeNull

protected String getValueFromNamedTokenExposeNull(String token,
                                                  String valueDelim)
                                           throws IfsException

getValueFromNamedTokenExposeNull() - get value from a token of the form "name : value". Return null if the value is omitted. If the value is specified as explciitly NULL, return the null token.

Throws:: IfsException

getStringsFromArrayToken

protected String[] getStringsFromArrayToken(String token,
                                            String arrayvalueDelim)
                                     throws IfsException

getStringsFromArrayToken() - get String array from a value of the form "{value1, value2, value3}".

Throws:: IfsException

getDoubleFromToken

protected Double getDoubleFromToken(String token,
                                    String valueformatDelim)
                             throws IfsException

getDateFromToken() - get Double from a value of the form "doublevalue ; dateformat".

Throws:: IfsException

getDateFromToken

protected Date getDateFromToken(String token,
                                String valueformatDelim)
                         throws IfsException

getDateFromToken() - get Date from a value of the form "datevalue ; dateformat".

Throws:: IfsException

identifyPublicObject

protected PublicObject identifyPublicObject(LibrarySession sess,
                                            Long id,
                                            String name,
                                            String valueDefaultName,
                                            String path,
                                            String className,
                                            String nameAttrname)
                                     throws IfsException

identifyPublicObject() - method used by several PublicObject admin classes to identify an object based on one of: 1. Id 2. Name.

Throws:: IfsException

identifyPublicObjects

protected PublicObject[] identifyPublicObjects(LibrarySession sess,
                                               Long id,
                                               String name,
                                               String className,
                                               String nameAttrname)
                                        throws IfsException

identifyPublicObjects() - return set of PublicObjects based on: 1. Id 2. Name.

Throws:: IfsException

identifyPublicObjectByPath

protected PublicObject identifyPublicObjectByPath(LibrarySession sess,
                                                  String path)
                                           throws IfsException

identifyPublicObjectByPath() - method used by several PublicObject admin classes to identify an object based on the path of the publi object.

Throws:: IfsException

Class AdminManager

Field Summary

Fields inherited from class oracle.ifs.common.BaseApp

Fields inherited from class oracle.ifs.common.BaseMain

Constructor Summary

Method Summary

Methods inherited from class oracle.ifs.common.BaseApp

Methods inherited from class oracle.ifs.common.BaseMain

Methods inherited from class java.lang.Object

Field Detail

m_ShowIdsInOutput

m_ShowStackTraces

m_TestMode

m_TestModeTransaction

m_TaskTransaction

m_ValueDelimiter

m_ArrayValueDelimiter

m_ValueFormatDelimiter

m_SectionParameterDelimiter

m_DefaultSectionParameterDelimiter

m_ArrayEnclosureBegin

m_ArrayEnclosureEnd

m_PermissionBundlePrefix

m_ExtendedPermissionPrefix

m_InputParamTokenList

m_InputParamTokenTable

m_CurrentTokenList

m_NullValueToken

m_OmitValueToken

m_ActiveSections

m_LastTaskSuccess

m_ReturnOnError

m_ExitOnError

m_LastException

m_TraceSections

m_SkipCreationIfExists

m_SkipFreeIfNotExists

m_AclAdmin

m_ApplicationObjectAdmin

m_AttributeValueAdmin

m_CategoryAdmin

m_ClassDomainAdmin

m_ClassObjectAdmin

m_ContextAdmin

m_DefinitionAdmin

m_DirectoryServiceAdmin

m_DirectoryUserAdmin

m_DirectoryGroupAdmin

m_DocumentAdmin

m_ExtendedPermissionAdmin

m_FamilyAdmin

m_FolderAdmin

m_FormatAdmin

m_MediaAdmin

m_MountPointAdmin

m_PermissionBundleAdmin

m_PropertyBundleAdmin

m_PolicyAdmin

m_SearchObjectAdmin

m_SelectorObjectAdmin

m_SystemLockObjectAdmin

m_UserProfileAdmin

m_ValueDefaultAdmin

m_ValueDomainAdmin

m_VersionDescriptionAdmin

m_VersionSeriesAdmin

Constructor Detail

AdminManager

AdminManager

Method Detail

main

run

getStringId

getAccessControlListAdmin

getApplicationObjectAdmin

getAttributeValueAdmin

getCategoryAdmin

getClassDomainAdmin

getClassObjectAdmin

getContextAdmin