com.filenet.api.admin

Interface CodeModule

  • All Superinterfaces:
    CmHoldable, Containable, Document, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Versionable

    public interface CodeModule
extends RepositoryObject, Document
    Represents a Java action handler to be stored on the Content Engine. An action handler is a user-implemented interface in the 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.

    Metadata

    Auditable: undefined
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: DocumentClassDefinition
    IsDependent: false
    IsHidden: true
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: Document
    See Also:
    About Server Extensions, Deploying Java Action Handlers
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.