com.filenet.api.admin

Interface IICEFixedContentDevice

All Superinterfaces:

EngineObject, FixedContentDevice, IndependentlyPersistableObject, IndependentObject, java.io.Serializable

public interface IICEFixedContentDevice
extends FixedContentDevice

Represents an external fixed content device accessible via an instance of IBM Content Integrator (formerly known as Information Integrator Content Edition or IICE). This representation serves a two-fold purpose: to identify and describe the external device, and to configure the behavior of the Content Federation Service (CFS) with respect to that device. CFS uses metadata from the external device to create and update FileNet P8 federated documents. (For information on content federation, and on the CFS import process in particular, see the CFSImportAgentConfiguration interface.)

As a content device description, this interface ties together these main entities:

• Federator Database
  This database acts as a transmission medium between the CFS exporter that pulls metadata from the external device and the CFS importer that creates and updates FileNet P8 documents using the metadata. To specify the database instance to use, set these properties: FederationJNDIDataSource and FederationJNDIXADataSource.
• External device/repository
  The external device can be a Content Services repository or any other type of repository supported by CFS. To specify the external repository to use and to allow CFS to access it, set these properties: SourceRepositoryName, CFSUserName, and CFSPassword properties.

As a means for configuring the behavior of CFS with respect to the external device, this interface can affect FileNet P8 document updates. CFS periodically pulls metadata and content from the external repository to keep FileNet P8 documents in sync with any changes made to the corresponding external documents. To control how CFS performs these periodic updates, set the FederationUpdateHasPriority property.

For information about the properties on this class, see IICEFixedContentDevice Properties.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: FixedContentDevice

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	get_CFSPassword() Returns the value of the CFSPassword property.
java.lang.String	get_CFSUserName() Returns the value of the CFSUserName property.
java.lang.String	get_FederationJNDIDataSource() Returns the value of the FederationJNDIDataSource property.
java.lang.String	get_FederationJNDIXADataSource() Returns the value of the FederationJNDIXADataSource property.
java.lang.Boolean	get_FederationUpdateHasPriority() Returns the value of the FederationUpdateHasPriority property.
java.lang.String	get_IICEConfigurationServerURL() Returns the value of the IICEConfigurationServerURL property.
java.lang.String	get_SourceRepositoryName() Returns the value of the SourceRepositoryName property.
void	set_CFSPassword(byte[] value) Sets the value of the CFSPassword property.
void	set_CFSUserName(java.lang.String value) Sets the value of the CFSUserName property.
void	set_FederationJNDIDataSource(java.lang.String value) Sets the value of the FederationJNDIDataSource property.
void	set_FederationJNDIXADataSource(java.lang.String value) Sets the value of the FederationJNDIXADataSource property.
void	set_FederationUpdateHasPriority(java.lang.Boolean value) Sets the value of the FederationUpdateHasPriority property.
void	set_IICEConfigurationServerURL(java.lang.String value) Sets the value of the IICEConfigurationServerURL property.
void	set_SourceRepositoryName(java.lang.String value) Sets the value of the SourceRepositoryName property.

Methods inherited from interface com.filenet.api.admin.FixedContentDevice

get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_FcpPoolIdleTimeoutSeconds, get_FcpPoolMaxInUse, get_FcpPoolMaxWaitSeconds, get_FcpPoolPreferredSize, get_Id, get_ImplementationClass, get_LastModifier, get_SiteSettings, get_VendorName, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_FcpPoolIdleTimeoutSeconds, set_FcpPoolMaxInUse, set_FcpPoolMaxWaitSeconds, set_FcpPoolPreferredSize, set_ImplementationClass, set_LastModifier, set_SiteSettings, set_VendorName

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_SourceRepositoryName

java.lang.String get_SourceRepositoryName()

Returns the value of the SourceRepositoryName property. For more information, see SourceRepositoryName Property.

set_SourceRepositoryName

void set_SourceRepositoryName(java.lang.String value)

Sets the value of the SourceRepositoryName property. For more information, see SourceRepositoryName Property.

get_CFSUserName

java.lang.String get_CFSUserName()

Returns the value of the CFSUserName property. For more information, see CFSUserName Property.

set_CFSUserName

void set_CFSUserName(java.lang.String value)

Sets the value of the CFSUserName property. For more information, see CFSUserName Property.

get_CFSPassword

byte[] get_CFSPassword()

Returns the value of the CFSPassword property. For more information, see CFSPassword Property.

set_CFSPassword

void set_CFSPassword(byte[] value)

Sets the value of the CFSPassword property. For more information, see CFSPassword Property.

get_FederationJNDIDataSource

java.lang.String get_FederationJNDIDataSource()

Returns the value of the FederationJNDIDataSource property. For more information, see FederationJNDIDataSource Property.

set_FederationJNDIDataSource

void set_FederationJNDIDataSource(java.lang.String value)

Sets the value of the FederationJNDIDataSource property. For more information, see FederationJNDIDataSource Property.

get_FederationJNDIXADataSource

java.lang.String get_FederationJNDIXADataSource()

Returns the value of the FederationJNDIXADataSource property. For more information, see FederationJNDIXADataSource Property.

set_FederationJNDIXADataSource

void set_FederationJNDIXADataSource(java.lang.String value)

Sets the value of the FederationJNDIXADataSource property. For more information, see FederationJNDIXADataSource Property.

get_FederationUpdateHasPriority

java.lang.Boolean get_FederationUpdateHasPriority()

Returns the value of the FederationUpdateHasPriority property. For more information, see FederationUpdateHasPriority Property.

set_FederationUpdateHasPriority

void set_FederationUpdateHasPriority(java.lang.Boolean value)

Sets the value of the FederationUpdateHasPriority property. For more information, see FederationUpdateHasPriority Property.

get_IICEConfigurationServerURL

java.lang.String get_IICEConfigurationServerURL()

Returns the value of the IICEConfigurationServerURL property. For more information, see IICEConfigurationServerURL Property.

set_IICEConfigurationServerURL

void set_IICEConfigurationServerURL(java.lang.String value)

Sets the value of the IICEConfigurationServerURL property. For more information, see IICEConfigurationServerURL Property.