com.crystaldecisions.sdk.plugin.destination.streamwork
Interface IServerStreamWorkOptions

public interface IServerStreamWorkOptions

The IServerStreamworkOptions object allows you to set the global options that are specific to the server. This interface should only be used for server configuration by administrator. It's not intended to be used by end users for configuring individual jobs

Method Summary

java.lang.String	getHttpProxyHost() Returns the host name of the http proxy for StreamWork consumer
int	getHttpProxyPort() Returns the port of the http proxy for StreamWork consumer
java.lang.String	getHttpProxyUserName() Returns the user name for the http proxy authentication for StreamWork consumer
boolean	isHttpProxyPasswordNotEmpty() Returns a boolean indicating whether the proxy password is set and not empty.
boolean	isHttpProxyPasswordSet() Returns a boolean indicating whether the proxy password is set.
void	setHttpProxyHost(java.lang.String server) Sets the host name of the http proxy for StreamWork consumer
void	setHttpProxyPassword(java.lang.String password) Sets the user name for the http proxy authentication for StreamWork consumer
void	setHttpProxyPort(int port) Sets the port of the http proxy for StreamWork consumer
void	setHttpProxyUserName(java.lang.String name) Sets the user credential for the http proxy authentication for StreamWork consumer

Method Detail

setHttpProxyHost

void setHttpProxyHost(java.lang.String server)
                      throws SDKException

Sets the host name of the http proxy for StreamWork consumer

Parameters:

server - The host name of the http proxy server for StreamWork consumer

Throws:

SDKException - SDKException.InvalidOperation exception is raised if the method is called by end users for configuring jobs

getHttpProxyHost

java.lang.String getHttpProxyHost()

Returns the host name of the http proxy for StreamWork consumer

Returns:

The host name of the http proxy for StreamWork consumer

setHttpProxyPort

void setHttpProxyPort(int port)
                      throws SDKException

Sets the port of the http proxy for StreamWork consumer

Parameters:

port - The port of the http proxy server for StreamWork consumer

Throws:

SDKException - SDKException.InvalidOperation exception is raised if the method is called by end users for configuring jobs

getHttpProxyPort

int getHttpProxyPort()

Returns the port of the http proxy for StreamWork consumer

Returns:

The port of the http proxy for StreamWork consumer

setHttpProxyUserName

void setHttpProxyUserName(java.lang.String name)
                          throws SDKException

Sets the user credential for the http proxy authentication for StreamWork consumer

Parameters:

name - The user name for the http proxy authentication for StreamWork consumer

Throws:

SDKException - SDKException.InvalidOperation exception is raised if the method is called by end users for configuring jobs

getHttpProxyUserName

java.lang.String getHttpProxyUserName()

Returns the user name for the http proxy authentication for StreamWork consumer

Returns:

The user name for the http proxy authentication for StreamWork consumer

setHttpProxyPassword

void setHttpProxyPassword(java.lang.String password)
                          throws SDKException

Sets the user name for the http proxy authentication for StreamWork consumer

Parameters:

password - The user name for the http proxy authentication for StreamWork consumer

Throws:

SDKException - SDKException.InvalidOperation exception is raised if the method is called by end users for configuring jobs

isHttpProxyPasswordSet

boolean isHttpProxyPasswordSet()
                               throws SDKException

Returns a boolean indicating whether the proxy password is set.

Returns:

true if the proxy password is set, falseThrows:

SDKException - This is thrown if the process is unsuccessful.

isHttpProxyPasswordNotEmpty

boolean isHttpProxyPasswordNotEmpty()
                                    throws SDKException

Returns a boolean indicating whether the proxy password is set and not empty.

Returns:

true if the proxy password is set and not empty, falseThrows:

SDKException - This is thrown if the process is unsuccessful.