com.stellent.cis.client.api.common.administrative.adapter
Interface ISCSAdapterConfig

All Superinterfaces:

ICISAdapterConfig, ICISObject, java.io.Serializable

public interface ISCSAdapterConfig
extends ICISAdapterConfig

Represents an active adapter, i.e. an adapter that is configured to a Stellent Content Server.

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.administrative.adapter.ICISAdapterConfig

PROPERTY_CLUSTER_PROPERTY, PROPERTY_GLOBAL_WEBPATH, TYPE_ACTIVE, TYPE_FIXED

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

void	clearAdvancedProperties() Clear the advanced properties
java.util.Properties	getAdvancedProperties()
java.lang.String	getAdvancedProperty(java.lang.String name)
java.lang.String	getAlgorithm() Optional SSL property, JVM defaults used if not specified.
int	getConnectionTimeout()
java.lang.String	getContentServerVault()
java.lang.String	getEnableSSL()
long	getEventPollingInterval()
java.lang.String	getEventPollingUserAuthType()
java.lang.String	getEventPollingUserDomain()
java.lang.String	getEventPollingUserHost()
java.lang.String	getEventPollingUserName()
java.lang.String	getEventPollingUserPassword()
java.lang.String	getFileCacheLocation()
int	getGlobalCacheCapacity()
java.lang.String	getHost()
java.lang.String	getKeystoreAlias()
java.lang.String	getKeystoreAliasPassword()
java.lang.String	getKeystoreFile() Optional SSL property, JVM defaults used if not specified.
java.lang.String	getKeystorePassword() Optional SSL property, JVM defaults used if not specified.
java.lang.String	getMappedServerVault()
java.lang.String	getMappedServerWeblayout()
java.lang.String	getPersistentConnection()
int	getPort()
java.lang.String	getResourceName()
int	getResourcePoolInitialSize()
int	getResourcePoolMaximumSize()
java.lang.String	getSocketType()
java.lang.String	getTrustManagerFile() Optional SSL property, JVM defaults used if not specified.
java.lang.String	getTrustManagerPassword() Optional SSL property, JVM defaults used if not specified.
int	getUserCacheCapacity()
java.lang.String	getVaultType()
java.lang.String	getVersion()
java.lang.String	getWebLayoutPrefix()
java.lang.String	getWebVaultPassword()
java.lang.String	getWebVaultPrefix()
java.lang.String	getWebVaultUserName()
boolean	isCacheEnabled()
boolean	isEventPollingEnabled()
boolean	isFileCacheEnabled()
boolean	isOptimizedVault()
boolean	isVaultConfigured()
void	setAdvancedProperties(java.util.Properties properties)
void	setAdvancedProperty(java.lang.String name, java.lang.String value) Set an advanced property
void	setAlgorithm(java.lang.String algorithm)
void	setCacheEnabled(boolean enabled)
void	setConnectionTimeout(int connectionTimeout)
void	setContentServerVault(java.lang.String vaultLocation)
void	setEnableSSL(java.lang.String enableSSL)
void	setEventPollingEnabled(boolean enabled)
void	setEventPollingInterval(long sleepTime)
void	setEventPollingUserAuthType(java.lang.String authType) Set the authentication type
void	setEventPollingUserDomain(java.lang.String domain) Set the event polling user domain (for NTLM)
void	setEventPollingUserHost(java.lang.String userHost) Set event polling user host
void	setEventPollingUserName(java.lang.String userName) Set the event polling user name
void	setEventPollingUserPassword(java.lang.String password) Set the event polling user password
void	setFileCacheEnabled(boolean enabled)
void	setFileCacheLocation(java.lang.String fileCache)
void	setGlobalCacheCapacity(int capacity)
void	setHost(java.lang.String host)
void	setKeystoreAlias(java.lang.String keystoreAlias)
void	setKeystoreAliasPassword(java.lang.String keystoreAliasPassword)
void	setKeystoreFile(java.lang.String keystoreFile)
void	setKeystorePassword(java.lang.String keystorePassword)
void	setMappedServerVault(java.lang.String mappedServerVault)
void	setMappedServerWeblayout(java.lang.String mappedServerWeblayout)
void	setPersistentConnection(java.lang.String persistentConnection)
void	setPort(int port)
void	setResourceName(java.lang.String resourceName)
void	setResourcePoolInitialSize(int initialSize) Set the initial size of the resource pool
void	setResourcePoolMaximumSize(int maxSize) Set the maximum size of the resource pool
void	setSocketType(java.lang.String socketType) Set the type of socket communication
void	setTrustManagerFile(java.lang.String trustManagerFile)
void	setTrustManagerPassword(java.lang.String trustManagerPassword)
void	setUserCacheCapacity(int capacity)
void	setVaultType(java.lang.String vaultType)
void	setVersion(java.lang.String version)
void	setWebLayoutPrefix(java.lang.String weblayoutPrefix)
void	setWebVaultPassword(java.lang.String password)
void	setWebVaultPrefix(java.lang.String webPrefix)
void	setWebVaultUserName(java.lang.String userName)

Methods inherited from interface com.stellent.cis.client.api.common.administrative.adapter.ICISAdapterConfig

addBeanDefinition, addTransientProperty, clearTransientProperties, deleteTransientProperty, getAdapterAttribute, getAdapterProperty, getBeanDefinitionNames, getBeanServicesXml, getDisplayConnectionUrl, getName, getSourceObject, getTransientProperty, getType, isActive, isDefault, isFixed, removeBeanDefinition, setAdapterAttribute, setAdapterProperty, setBeanServicesXml, setDefault, setName

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Method Detail

getResourceName

java.lang.String getResourceName()

Returns:

the name of the resource pool or JCA JNDI name, depending on configuration

setResourceName

void setResourceName(java.lang.String resourceName)

Parameters:

resourceName - the resource name

getHost

java.lang.String getHost()

Returns:

the content server host name

setHost

void setHost(java.lang.String host)

Parameters:

host - the content server host

getPort

int getPort()

Returns:

the content server port

setPort

void setPort(int port)

Parameters:

port - the content server port

getSocketType

java.lang.String getSocketType()

Returns:

socket type

setSocketType

void setSocketType(java.lang.String socketType)

Set the type of socket communication

Parameters:

socketType - The type of socket communication (i.e. "web" or "socket")

isOptimizedVault

boolean isOptimizedVault()

Returns:

true if the adapter is configured for optimized file transfer (i.e. getVaultType() is "web" or "mapped")

setVaultType

void setVaultType(java.lang.String vaultType)

Parameters:

vaultType - the vault type, either "web", "mapped", or "default"

getVaultType

java.lang.String getVaultType()

Returns:

the vault type ("web", "mapped" or "default"), default value is "default"

isVaultConfigured

boolean isVaultConfigured()

Returns:

true if a vault location has been configured

getContentServerVault

java.lang.String getContentServerVault()

Returns:

the content server vault location

setContentServerVault

void setContentServerVault(java.lang.String vaultLocation)

Parameters:

vaultLocation - the content server vault location

getMappedServerVault

java.lang.String getMappedServerVault()

Returns:

the mapped vault location on the application server

setMappedServerVault

void setMappedServerVault(java.lang.String mappedServerVault)

Parameters:

mappedServerVault - the mapped server vault

getMappedServerWeblayout

java.lang.String getMappedServerWeblayout()

Returns:

the location for weblayout files as seen by the application server

setMappedServerWeblayout

void setMappedServerWeblayout(java.lang.String mappedServerWeblayout)

Parameters:

mappedServerWeblayout - the mapped location for weblayout files as seen by the application server

setWebVaultUserName

void setWebVaultUserName(java.lang.String userName)

Parameters:

userName - the username to use when retrieving files via the "web" optimized vault transfer

getWebVaultUserName

java.lang.String getWebVaultUserName()

Returns:

the web vault username

setWebVaultPassword

void setWebVaultPassword(java.lang.String password)

Parameters:

password - the password to use when retrieving files via the "web" optimized vault transfer

getWebVaultPassword

java.lang.String getWebVaultPassword()

Returns:

the web vault password

setWebVaultPrefix

void setWebVaultPrefix(java.lang.String webPrefix)

Parameters:

webPrefix - the prefix to append with the file path (usually http://host:port)

getWebVaultPrefix

java.lang.String getWebVaultPrefix()

Returns:

the prefix to append with the file path (usually http://host:port) when retrieving files from the vault

getWebLayoutPrefix

java.lang.String getWebLayoutPrefix()

Returns:

the prefix to append with the file path (usually http://host:port) when retrieving files from the weblayout

setWebLayoutPrefix

void setWebLayoutPrefix(java.lang.String weblayoutPrefix)

Parameters:

weblayoutPrefix - the web (i.e. http://hostname/path) prefix for weblayout files

getAdvancedProperties

java.util.Properties getAdvancedProperties()

Returns:

advanced configuration properties, allowing the setting/disabling of properties (caching, pooling, etc.)

setAdvancedProperties

void setAdvancedProperties(java.util.Properties properties)

Parameters:

properties - the advanced properties

setAdvancedProperty

void setAdvancedProperty(java.lang.String name,
                         java.lang.String value)

Set an advanced property

Parameters:

name - the property name

value - the property value

getAdvancedProperty

java.lang.String getAdvancedProperty(java.lang.String name)

Parameters:

name - the property name

Returns:

the property value

clearAdvancedProperties

void clearAdvancedProperties()

Clear the advanced properties

getVersion

java.lang.String getVersion()

Returns:

the version of the content server this adapter represents

setVersion

void setVersion(java.lang.String version)

Parameters:

version - the version of the content server this adapter represents

getKeystoreFile

java.lang.String getKeystoreFile()

Optional SSL property, JVM defaults used if not specified.

Returns:

The path location of the keystore to use. (only valid in SSL based connections)

setKeystoreFile

void setKeystoreFile(java.lang.String keystoreFile)

Parameters:

keystoreFile - The path location of the keystore to use. (only valid in SSL based connections)

getKeystorePassword

java.lang.String getKeystorePassword()

Optional SSL property, JVM defaults used if not specified.

Returns:

The password to access the keystore. (only valid in SSL based connections)

setKeystorePassword

void setKeystorePassword(java.lang.String keystorePassword)

Parameters:

keystorePassword - The password to access the keystore. (only valid in SSL based connections)

getTrustManagerFile

java.lang.String getTrustManagerFile()

Optional SSL property, JVM defaults used if not specified.

Returns:

The path location of the trustmanager to use. (only valid in SSL based connections)

setTrustManagerFile

void setTrustManagerFile(java.lang.String trustManagerFile)

Parameters:

trustManagerFile - The path location of the trustmanager to use. (only valid in SSL based connections)

getTrustManagerPassword

java.lang.String getTrustManagerPassword()

Optional SSL property, JVM defaults used if not specified.

Returns:

The password to access the trustmanager. (only valid in SSL based connections)

setTrustManagerPassword

void setTrustManagerPassword(java.lang.String trustManagerPassword)

Parameters:

trustManagerPassword - The password to access the trustmanager. (only valid in SSL based connections)

getAlgorithm

java.lang.String getAlgorithm()

Optional SSL property, JVM defaults used if not specified.

Returns:

The algorithm to use to encrypt data. (only valid in SSL based connections)

setAlgorithm

void setAlgorithm(java.lang.String algorithm)

Parameters:

algorithm - The algorithm to use to encrypt data. (only valid in SSL based connections)

getEnableSSL

java.lang.String getEnableSSL()

Returns:

Indicates whether or not SSL should be enabled.

setEnableSSL

void setEnableSSL(java.lang.String enableSSL)

Parameters:

enableSSL - Indicates whether or not SSL should be enabled.

getKeystoreAlias

java.lang.String getKeystoreAlias()

Returns:

Alias to use when accessing keystore

setKeystoreAlias

void setKeystoreAlias(java.lang.String keystoreAlias)

Parameters:

keystoreAlias - Alias to use when accessing keystore

getKeystoreAliasPassword

java.lang.String getKeystoreAliasPassword()

Returns:

The password to use when using specified keystore alias.

setKeystoreAliasPassword

void setKeystoreAliasPassword(java.lang.String keystoreAliasPassword)

Parameters:

keystoreAliasPassword - The password to use when using specified keystore alias.

setPersistentConnection

void setPersistentConnection(java.lang.String persistentConnection)

Parameters:

persistentConnection - Whether or not to use a persistent socket or close each time.

getPersistentConnection

java.lang.String getPersistentConnection()

Returns:

Whether or not to use a persistent socket or close each time.

setConnectionTimeout

void setConnectionTimeout(int connectionTimeout)

Parameters:

connectionTimeout - When using persistent connections, this value is the maximum amount of time the connection will wait for response.

getConnectionTimeout

int getConnectionTimeout()

Returns:

When using persistent connections, this value is the maximum amount of time the connection will wait for response.

isCacheEnabled

boolean isCacheEnabled()

Returns:

true if the cache is enabled

setCacheEnabled

void setCacheEnabled(boolean enabled)

Parameters:

enabled - the flag to enable the cache

getUserCacheCapacity

int getUserCacheCapacity()

Returns:

the capacity of the user cache

setUserCacheCapacity

void setUserCacheCapacity(int capacity)

Parameters:

capacity - the size of the user cache

getGlobalCacheCapacity

int getGlobalCacheCapacity()

Returns:

the size of the global cache

setGlobalCacheCapacity

void setGlobalCacheCapacity(int capacity)

Parameters:

capacity - the size of the global cache

getEventPollingInterval

long getEventPollingInterval()

Returns:

how often the content server is pinged to generated events in the CIS layer

setEventPollingInterval

void setEventPollingInterval(long sleepTime)

Parameters:

sleepTime - the amount of time to sleep between polling the content server

isEventPollingEnabled

boolean isEventPollingEnabled()

Returns:

true if the event polling is enabled

setEventPollingEnabled

void setEventPollingEnabled(boolean enabled)

Parameters:

enabled - enable or disable the event polling subsystem

getEventPollingUserName

java.lang.String getEventPollingUserName()

Returns:

the event polling user name

setEventPollingUserName

void setEventPollingUserName(java.lang.String userName)

Set the event polling user name

Parameters:

userName - the user name to use

getEventPollingUserPassword

java.lang.String getEventPollingUserPassword()

Returns:

the event polling user password

setEventPollingUserPassword

void setEventPollingUserPassword(java.lang.String password)

Set the event polling user password

Parameters:

password - the password to use for authenticated adatpers during event polling

getEventPollingUserAuthType

java.lang.String getEventPollingUserAuthType()

Returns:

the authentication type for the event poller

setEventPollingUserAuthType

void setEventPollingUserAuthType(java.lang.String authType)

Set the authentication type

Parameters:

authType - the auth type

getEventPollingUserHost

java.lang.String getEventPollingUserHost()

Returns:

the event polling user host (for NTLM)

setEventPollingUserHost

void setEventPollingUserHost(java.lang.String userHost)

Set event polling user host

Parameters:

userHost - the user host (for NTLM)

getEventPollingUserDomain

java.lang.String getEventPollingUserDomain()

Returns:

the event polling user domain

setEventPollingUserDomain

void setEventPollingUserDomain(java.lang.String domain)

Set the event polling user domain (for NTLM)

Parameters:

domain - The user domain

getResourcePoolInitialSize

int getResourcePoolInitialSize()

Returns:

the maximum resource pool size

setResourcePoolInitialSize

void setResourcePoolInitialSize(int initialSize)

Set the initial size of the resource pool

Parameters:

initialSize - The initial size

getResourcePoolMaximumSize

int getResourcePoolMaximumSize()

Returns:

the minimum resource pool size

setResourcePoolMaximumSize

void setResourcePoolMaximumSize(int maxSize)

Set the maximum size of the resource pool

Parameters:

maxSize - The maximum size

isFileCacheEnabled

boolean isFileCacheEnabled()

Returns:

true if the file caching is enabled

setFileCacheEnabled

void setFileCacheEnabled(boolean enabled)

Parameters:

enabled - turn on/off the file caching mechanism

getFileCacheLocation

java.lang.String getFileCacheLocation()

Returns:

the root directory of the file cache

setFileCacheLocation

void setFileCacheLocation(java.lang.String fileCache)

Parameters:

fileCache - the file cache location