com.businessobjects.sdk.plugin.desktop.remotecluster
Interface IRemoteClusterBase

All Known Subinterfaces:

IRemoteCluster

public interface IRemoteClusterBase

This interface represents a remote repository. It contains information used to connect to a remote site for the purpose of replicating content from that repository to this one.

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID

Method Summary

java.lang.String	getAuthType() Sets the authentication method to use when logging on to the remote cluster.
ICleanupOptions	getCleanupOptions() Returns the cleanup options for replicated objects that have been removed from the origin cluster.
java.lang.String	getClusterURI() Gets the Web Services URI to use when connecting to the remote cluster.
java.lang.String	getCMS() Gets the CMS or cluster name to use when logging on to the remote cluster.
java.lang.String	getUserName() Gets the username to use when logging on to the remote cluster.
boolean	isPasswordNotEmpty() Checks whether the password to use during remote cluster logon is empty.
boolean	isPasswordSet() Checks whether the password to use during remote cluster logon has been set.
void	setAuthType(java.lang.String authType) Sets the authentication method to use when logging on to the remote cluster.
void	setClusterURI(java.lang.String uri) Sets the Web Services URI to use when connecting to the remote cluster.
void	setCMS(java.lang.String cms) Sets the CMS or cluster name to use when logging on to the remote cluster.
void	setPassword(java.lang.String password) Sets the password to use when logging on to the remote cluster.
void	setUserName(java.lang.String username) Sets the username to use when logging on to the remote cluster.

Field Detail

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

setClusterURI

void setClusterURI(java.lang.String uri)

Sets the Web Services URI to use when connecting to the remote cluster.

Parameters:

uri - the URI to use

getClusterURI

java.lang.String getClusterURI()
                               throws SDKException

Gets the Web Services URI to use when connecting to the remote cluster.

Returns:

the URI to use. May be null.

Throws:

SDKException

InfoObject properties to query for:

SI_CLUSTER_URI

setUserName

void setUserName(java.lang.String username)

Sets the username to use when logging on to the remote cluster.

Parameters:

username - the BOE username

getUserName

java.lang.String getUserName()
                             throws SDKException

Gets the username to use when logging on to the remote cluster.

Returns:

the BOE username. May be null.

Throws:

SDKException

InfoObject properties to query for:

SI_USERNAME

setPassword

void setPassword(java.lang.String password)

Sets the password to use when logging on to the remote cluster.

Parameters:

password - the password to use

isPasswordSet

boolean isPasswordSet()

Checks whether the password to use during remote cluster logon has been set.

Returns:

true if the password has been set, false otherwise.

InfoObject properties to query for:

SI_CRED_KEY

isPasswordNotEmpty

boolean isPasswordNotEmpty()

Checks whether the password to use during remote cluster logon is empty.

Returns:

true if the password is empty, false otherwise.

InfoObject properties to query for:

SI_CRED_KEY

setCMS

void setCMS(java.lang.String cms)

Sets the CMS or cluster name to use when logging on to the remote cluster.

Parameters:

cms - the CMS or cluster name to use

getCMS

java.lang.String getCMS()
                        throws SDKException

Gets the CMS or cluster name to use when logging on to the remote cluster.

Returns:

the CMS or cluster name to use. May be null.

Throws:

SDKException

InfoObject properties to query for:

SI_CLUSTER_NAME

setAuthType

void setAuthType(java.lang.String authType)

Sets the authentication method to use when logging on to the remote cluster.

Parameters:

authType - the authentication method to use

getAuthType

java.lang.String getAuthType()
                             throws SDKException

Sets the authentication method to use when logging on to the remote cluster.

Returns:

the authentication method to use. May be null.

Throws:

SDKException

InfoObject properties to query for:

SI_AUTH_TYPE

getCleanupOptions

ICleanupOptions getCleanupOptions()
                                  throws SDKException

Returns the cleanup options for replicated objects that have been removed from the origin cluster.

Returns:

an ICleanupOptions interface that can be used to set or retrieve cleanup options for replicated objects that have been removed from the originating cluster.

Throws:

SDKException

InfoObject properties to query for:

SI_CLEANUP_OPTIONS