oracle.ifs.beans

Class ApplicationToken

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.ApplicationToken

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieApplicationToken

public class ApplicationToken
extends TieApplicationObject

A ApplicationToken represents a token used for applicaiton purposes, where the token value is unique. All access to the tokens is restricted to system sessions. An efficient lookup mechanism (by token) is provided.

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	TOKENINFO_ATTRIBUTE The name of the Attribute used to reference the optional token info.
static String	TOKENVALUE_ATTRIBUTE The name of the Attribute used to reference the token value.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationToken(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct an ApplicationToken object.

Method Summary

Modifier and Type	Method and Description
static ApplicationToken	create(LibrarySession session, ApplicationTokenDefinition tokenDef) Creates a new ApplicationToken from the specified definition.
static ApplicationToken[]	findAll(LibrarySession session) Returns all ApplicationTokens.
static ApplicationToken	findByName(LibrarySession session, String tokenValue) Finds a ApplicationTokens instance by token value Returns null if no ApplicationToken with the given token value could be found.
String	getTokenInfo() Returns the token info.
String	getTokenValue() Returns the token value.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a PublicObject.
protected void	postUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the update of a PublicObject.
protected void	preCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the creation of a PublicObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a PublicObject.

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryFolderPathIds, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, preCopy, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

TOKENVALUE_ATTRIBUTE

public static final String TOKENVALUE_ATTRIBUTE

The name of the Attribute used to reference the token value.

See Also:

Constant Field Values

(Published)

TOKENINFO_ATTRIBUTE

public static final String TOKENINFO_ATTRIBUTE

The name of the Attribute used to reference the optional token info.

See Also:

Constant Field Values

(Published)

Constructor Detail

ApplicationToken

protected ApplicationToken(LibrarySession session,
                           Long id,
                           Long classId,
                           S_LibraryObjectData data)
                    throws IfsException

Construct an ApplicationToken object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getTokenValue

public String getTokenValue()
                     throws IfsException

Returns the token value.

Cannot return null.

Returns:

the token value

Throws:

IfsException - if the operation fails

getTokenInfo

public String getTokenInfo()
                    throws IfsException

Returns the token info.

Can return null.

Returns:

the token info

Throws:

IfsException - if the operation fails

preCreate

protected void preCreate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the creation of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_PublicObject.

Overrides:

preCreate in class PublicObject

Parameters:

lodef - object definition that will be used to create the object

Throws:

IfsException - if the operation fails

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Extensibility point to perform actions after the creation of a PublicObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class ApplicationObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if the operation fails

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the update of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_PublicObject.

Overrides:

preUpdate in class PublicObject

Parameters:

lodef - object definition used to define how the target object will be updated

Throws:

IfsException - if operation fails.

postUpdate

protected void postUpdate(LibraryObjectDefinition lodef)
                   throws IfsException

Extensibility point to perform actions after the update of a PublicObject.

Create any categories that are specified in the definition.

Overrides:

postUpdate in class PublicObject

Parameters:

lodef - object definition used to define how the target object was updated

Throws:

IfsException - if operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

Override to free all existing categories, in such a way that the PO doesn't get updated for each category free.

Overrides:

preFree in class ApplicationObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

create

public static ApplicationToken create(LibrarySession session,
                                      ApplicationTokenDefinition tokenDef)
                               throws IfsException

Creates a new ApplicationToken from the specified definition.

Parameters:

session - the session context

tokenDef - the definition for the desired token

Returns:

the new ApplicationToken

Throws:

IfsException - 35400: if an object with the specified token value already exists
other: if the operation fails

findByName

public static ApplicationToken findByName(LibrarySession session,
                                          String tokenValue)
                                   throws IfsException

Finds a ApplicationTokens instance by token value

Returns null if no ApplicationToken with the given token value could be found.

Note: the tokenValue must be an exact, case-sensitive match.

Parameters:

session - the current session.

tokenValue - the token value of the ApplicationToken to return.

Returns:

the ApplicationToken instance with the given token, or null if it does't exist.

Throws:

IfsException - if the operation fails.

findAll

public static ApplicationToken[] findAll(LibrarySession session)
                                  throws IfsException

Returns all ApplicationTokens.

Parameters:

session - the current session.

Returns:

all ApplicationTokens.

Throws:

IfsException - if the operation fails.

(Published)