com.filenet.api.admin
Interface CodeModule
- All Superinterfaces:
- Containable, Document, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Versionable
public interface CodeModule
- extends RepositoryObject, Document
Represents a user-implemented Java event handler that executes
when an Action
-based object's events are raised.
The event handler can be a Java class or JAR file, and must reside on the Content Engine.
To create a CodeModule
object, call the createInstance
method on the
Factory.CodeModule
class,
and then set the content elements of the Java module with the set_ContentElements
method.
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, acceptable MIME types are "application/java-archive",
"application/x-compressed", "application/x-zip-compressed", "application/zip", and "multipart/x-zip".
Note:
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 in the content element list, the object will throw an EVENT_CM_CONTENTREFERENCE_NOT_ALLOWED
exception.
If you create a new version of a CodeModule
, such as by updating the event handler content, then you must set the new version to the
CodeModule property of any Action
-based object for which the new
To instantiate a CodeModule
object, call the getInstance
or fetchInstance
method on the Factory.CodeModule
class.
As an alternative to representing a Java event handler as a CodeModule
object,
you could specify the Java event handler in the classpath of your application server.
However, in an enterprise environment, we recommend that you check in
an event 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 event handlers in the classpath of an
application server, you must manually distribute them to new systems.
For cache configuration considerations, see the applicable code module-related methods in the
ServerCacheConfiguration
interface.
Metadata
Auditable: undefined
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: DocumentClassDefinition
IsDependent: false
IsHidden: true
Searchable: true
StorageType: ObjectStore
SuperclassName: Document
- See Also:
DocumentClassifier
,
DocumentLifecycleActionHandler
,
EventActionHandler
,
Event Handler Code Guidelines
Methods inherited from interface com.filenet.api.core.Document |
accessContentStream, applySecurityTemplate, changeState, checkin, get_ChildDocuments, get_ChildRelationships, get_ClassificationStatus, 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_CompoundDocumentState, set_ContentElements, set_DocumentLifecyclePolicy, set_MimeType, set_OwnerDocument, set_PublicationInfo, set_PublishingSubsidiaryFolder, set_SecurityParent, set_SourceDocument, set_StorageArea, set_StoragePolicy, takeFederatedOwnership, unlock, updateLock |
Methods inherited from interface com.filenet.api.core.Versionable |
cancelCheckout, changeClass, checkout, createAnnotation, demoteVersion, freeze, 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 |
Methods inherited from interface com.filenet.api.core.Containable |
get_ActiveMarkings, get_Annotations, get_AuditedEvents, get_Containers, 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_ReferencingActions
ActionSet get_ReferencingActions()
- Returns the value of the ReferencingActions property. For more information, see
ReferencingActions Property.
© Copyright IBM Corporation 2006, 2009. All rights reserved.