Skip navigation links

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

All Superinterfaces:

ICISObject, java.io.Serializable

All Known Subinterfaces:

ISCSAdapterConfig, ISISAdapterConfig

public interface ICISAdapterConfig

extends ICISObject

Represents an adapter configuration object in the system.

Field Summary

static java.lang.String	PROPERTY_CLUSTER_PROPERTY global property defining the cluster property
static java.lang.String	PROPERTY_GLOBAL_WEBPATH global property defining the default web path
static java.lang.String	TYPE_ACTIVE type string for active (ISCSAdapterConfig) content server configurations
static java.lang.String	TYPE_FIXED type string for fixed (ISISAdapterConfig image server configurations

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

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

void	addBeanDefinition(java.lang.String xml) Add a bean definition
void	addTransientProperty(java.lang.String name, java.lang.Object value) Add a transient property to the adapter.
void	clearTransientProperties() Clear the transient properties
java.lang.Object	deleteTransientProperty(java.lang.String name) Delete the transient property
java.lang.String	getAdapterAttribute(java.lang.String name) Retrieve a generic adapter attribute
java.lang.String	getAdapterProperty(java.lang.String name) Retrieve a generic property value from the adapter
java.util.Collection	getBeanDefinitionNames()
java.lang.String	getBeanServicesXml()
java.lang.String	getDisplayConnectionUrl()
java.lang.String	getName()
java.lang.Object	getSourceObject() Get the object that was used for initialization.
java.lang.Object	getTransientProperty(java.lang.String name) Retrieve the transient property value
java.lang.String	getType()
boolean	isActive()
boolean	isDefault()
boolean	isFixed()
void	removeBeanDefinition(java.lang.String name)
void	setAdapterAttribute(java.lang.String name, java.lang.String value) Set a generic adapter attribute value
void	setAdapterProperty(java.lang.String name, java.lang.String value) Set a generic property value on the adapter
void	setBeanServicesXml(java.lang.String xml)
void	setDefault(boolean isDefault)
void	setName(java.lang.String name)

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

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

Field Detail

PROPERTY_GLOBAL_WEBPATH

static final java.lang.String PROPERTY_GLOBAL_WEBPATH

global property defining the default web path

See Also:

Constant Field Values

PROPERTY_CLUSTER_PROPERTY

static final java.lang.String PROPERTY_CLUSTER_PROPERTY

global property defining the cluster property

See Also:

Constant Field Values

TYPE_ACTIVE

static final java.lang.String TYPE_ACTIVE

type string for active (ISCSAdapterConfig) content server configurations

See Also:

Constant Field Values

TYPE_FIXED

static final java.lang.String TYPE_FIXED

type string for fixed (ISISAdapterConfig image server configurations

See Also:

Constant Field Values

Method Detail

getSourceObject

java.lang.Object getSourceObject()

Get the object that was used for initialization. For internal use only.

Returns:

the source object

getType

java.lang.String getType()

Returns:

the type of adapter

isFixed

boolean isFixed()

Returns:

true if this is a fixed (Stellent Image Server) adapter

isActive

boolean isActive()

Returns:

true if this is an active (Stellent Content Server) adapter

getName

java.lang.String getName()

Returns:

the name of the adapter

setName

void setName(java.lang.String name)

Parameters:

name - the name of the adapter

getDisplayConnectionUrl

java.lang.String getDisplayConnectionUrl()

Returns:

a friendly display of the connection represented by this adapter

isDefault

boolean isDefault()

Returns:

true if this is the default adapter

setDefault

void setDefault(boolean isDefault)

Parameters:

isDefault - the default flag

addTransientProperty

void addTransientProperty(java.lang.String name,
                          java.lang.Object value)

Add a transient property to the adapter. A transient property will be available on the adapter but will not be persisted after server restarts.

Parameters:

name - the property name

value - the property value (should be serializable)

deleteTransientProperty

java.lang.Object deleteTransientProperty(java.lang.String name)

Delete the transient property

Parameters:

name - the property name

Returns:

the current value of the property or null if no such property existed

getTransientProperty

java.lang.Object getTransientProperty(java.lang.String name)

Retrieve the transient property value

Parameters:

name - the property name

Returns:

the property value or null if no such property exists

clearTransientProperties

void clearTransientProperties()

Clear the transient properties

getAdapterProperty

java.lang.String getAdapterProperty(java.lang.String name)

Retrieve a generic property value from the adapter

Parameters:

name - the property name

Returns:

the property value

setAdapterProperty

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

Set a generic property value on the adapter

Parameters:

name - the property name

value - the property value

getAdapterAttribute

java.lang.String getAdapterAttribute(java.lang.String name)

Retrieve a generic adapter attribute

Parameters:

name - the attribute name

Returns:

the attribute value

setAdapterAttribute

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

Set a generic adapter attribute value

Parameters:

name - the attribute name

value - the attribute value

setBeanServicesXml

void setBeanServicesXml(java.lang.String xml)

Parameters:

xml - the xml containing the beans for this adapter

getBeanServicesXml

java.lang.String getBeanServicesXml()

Returns:

the bean services xml snippet

addBeanDefinition

void addBeanDefinition(java.lang.String xml)
                       throws java.io.IOException

Add a bean definition

Parameters:

xml - the xml definition of the bean

Throws:

java.io.IOException

removeBeanDefinition

void removeBeanDefinition(java.lang.String name)
                          throws java.io.IOException

Parameters:

name - the name of the bean

Throws:

java.io.IOException

getBeanDefinitionNames

java.util.Collection getBeanDefinitionNames()
                                            throws java.io.IOException

Returns:

the collection of Strings representing the bean definition names

Throws:

java.io.IOException

Skip navigation links