public interface CodeModule extends RepositoryObject, Document
Engine
package.
A handler executes as a server-side extension to the Content Engine when certain actions are performed.
As an alternative to representing a Java action handler as a CodeModule
object,
you could specify the Java action handler in the classpath of your application server.
However, it is recommended that you check in
an action handler and any supporting libraries as a code module.
Code modules are automatically available when deploying the Content Engine to multiple application server instances,
or moving your content metadata from one system to another. If you reference action handlers in the classpath of an
application server, you must manually distribute the action handlers to new systems.
To create a CodeModule
object, call the createInstance
method on the
Factory.CodeModule
class,
and then set the content elements on the object. A content element can be a Java class or a JAR file.
Each content element must have the correct MimeType property value. For content elements containing a Java class,
acceptable MIME types are "application/java", "application/java-byte-code", and "application/x-java-class".
For content elements containing a JAR file, the MIME type must be "application/java-archive".
The content elements that you set on a CodeModule
object must be of type ContentTransfer
,
not ContentReference
. If you attempt to save a CodeModule
object with a ContentReference
type, the server will throw an EVENT_CM_CONTENTREFERENCE_NOT_ALLOWED
exception.
Note If you update an action handler, you must update the CodeModule
object with the new version of the action handler.
Then you must update the CodeModule property of any Action
-based subobjects that reference the
CodeModule
object that has been updated.
For cache configuration considerations, see the applicable code module-related methods in the
ServerCacheConfiguration
interface.
Modifier and Type | Method and Description |
---|---|
ActionSet |
get_ReferencingActions()
Returns the value of the ReferencingActions property.
|
accessContentStream, applySecurityTemplate, changeState, checkin, get_ChildDocuments, get_ChildRelationships, get_ClassificationStatus, get_CmIndexingFailureCode, get_CmRetentionDate, get_CmThumbnails, get_CompoundDocumentState, get_ContentElements, get_ContentElementsPresent, get_ContentRetentionDate, get_ContentSize, get_CurrentState, get_CurrentVersion, get_DateContentLastAccessed, get_DependentDocuments, get_DestinationDocuments, get_DocumentLifecyclePolicy, get_IndexationId, get_IsInExceptionState, get_MimeType, get_OwnerDocument, get_ParentDocuments, get_ParentRelationships, get_PublicationInfo, get_PublishingSubsidiaryFolder, get_ReleasedVersion, get_SecurityParent, get_SourceDocument, get_StorageArea, get_StorageLocation, get_StoragePolicy, get_WorkflowSubscriptions, getPublicationStatus, isLocked, lock, moveContent, publish, republish, set_CmRetentionDate, set_CompoundDocumentState, set_ContentElements, set_DocumentLifecyclePolicy, set_MimeType, set_OwnerDocument, set_PublicationInfo, set_PublishingSubsidiaryFolder, set_SecurityParent, set_SourceDocument, set_StorageArea, set_StoragePolicy, takeFederatedOwnership, unlock, updateLock
getObjectStore
cancelCheckout, changeClass, checkout, createAnnotation, demoteVersion, freeze, get_CmIsMarkedForDeletion, get_DateCheckedIn, get_FoldersFiledIn, get_IsCurrentVersion, get_IsFrozenVersion, get_IsReserved, get_IsVersioningEnabled, get_MajorVersionNumber, get_MinorVersionNumber, get_Reservation, get_ReservationType, get_SecurityFolder, get_Versions, get_VersionSeries, get_VersionStatus, promoteVersion, set_DateCheckedIn, set_SecurityFolder
get_ActiveMarkings, get_Annotations, get_AuditedEvents, get_Containers, get_CoordinatedTasks, get_Creator, get_DateCreated, get_DateLastModified, get_Id, get_LastModifier, get_LockOwner, get_LockTimeout, get_LockToken, get_Name, get_Owner, get_Permissions, get_SecurityPolicy, set_Creator, set_DateCreated, set_DateLastModified, set_LastModifier, set_Owner, set_Permissions, set_SecurityPolicy
get_CmHoldRelationships
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
ActionSet get_ReferencingActions()
© Copyright IBM Corporation 2006, 2015. All rights reserved.