com.uc4.communication

Class ConnectionAttributes

java.lang.Object

com.uc4.communication.ConnectionAttributes

public class ConnectionAttributes
extends java.lang.Object

This class contains information about the connection to the UC4 Server.

Constructor Summary

Constructors

Constructor and Description
ConnectionAttributes() Creates ConnectionAttributes.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClient()
int	getDefaultJobPlanElse() Returns the default JobPlan task ELSE Action.
java.lang.String	getDepartment()
java.lang.String	getEncoding() Returns the encoding used for communication between API and CP.
byte[]	getKerberosToken() Returns the kerberos token.
java.lang.String	getKicks() This connection is registered to receive the kick messages returned by this procedure.
java.lang.String	getLanguage()
java.lang.String	getPassword()
java.lang.String	getPasswordType() Returns the type of the secret if the defined in the Connection.open() method.
java.lang.String	getRemoteHost() Returns the host name of the API user.
java.lang.String	getRemoteID() Returns the remote ID.
java.lang.String	getServerVersion() Returns the version of the the Automation Engine.
java.lang.String	getSessionId()
java.util.TimeZone	getSessionTimeZone() Gets the session time zone.
java.lang.String	getSpnegoToken() Returns the browser token.
java.lang.String	getSystemName()
java.lang.String	getToken() Returns a logon token which can be used instead of a password.
java.lang.String	getTokenAgent() Returns the Agent name if the API is used within an UC4 Agent.
com.uc4.translate.Message	getTranslator() Returns the message translator.
java.lang.String	getUserIdnr()
java.lang.String	getUserName()
long	getWFRunID() Returns the ARA Workflow ID.
boolean	hasAdoptPrivilege() Returns true if this user is allowed to execute the AdoptTask request.
boolean	hasBackendVariablePrivilege() Returns true if this user is allowed to create and modify backend variables.
boolean	hasSelectiveStatisticsPrivilege() Returns true if this user is allowed to access selective statistics.
boolean	hasSystemOverviewPrivilege() Returns true if this user is allowed to read the system overview.
boolean	isDeploymentClient() Returns true if deployment is enabled for this connection otherwise false.
boolean	isRequestTest() Returns true if internal test are enabled.
boolean	isSSO() Returns true if single sign on is active.
boolean	isValid() Returns true if this connection is valid.
Settings	settings()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionAttributes

public ConnectionAttributes()

Creates ConnectionAttributes.

Method Detail

isRequestTest

public boolean isRequestTest()

Returns true if internal test are enabled. To enable internal request tests call the method Connection#setDebug and set the second parameter to true.

Returns:

Boolean indicating if internal test are enabled or not.

settings

public Settings settings()

Returns:

User Interface settings

isDeploymentClient

public boolean isDeploymentClient()

Returns true if deployment is enabled for this connection otherwise false.

Returns:

true if deployment is enabled

getTokenAgent

public java.lang.String getTokenAgent()

Returns the Agent name if the API is used within an UC4 Agent.

Returns:

Agentname or null if not set

getToken

public java.lang.String getToken()

Returns a logon token which can be used instead of a password.

Returns:

Logon token

getRemoteHost

public java.lang.String getRemoteHost()

Returns the host name of the API user. This name will be shown in the system overview.

Returns:

Remote host name

getServerVersion

public java.lang.String getServerVersion()

Returns the version of the the Automation Engine.

Returns:

Server version

hasSystemOverviewPrivilege

public boolean hasSystemOverviewPrivilege()

Returns true if this user is allowed to read the system overview.

Returns:

Boolean indicating if the user is allowed to read the system overview

hasAdoptPrivilege

public boolean hasAdoptPrivilege()

Returns true if this user is allowed to execute the AdoptTask request.

Returns:

Boolean indicating if the user is allowed to execute the AdoptTask request

hasSelectiveStatisticsPrivilege

public boolean hasSelectiveStatisticsPrivilege()

Returns true if this user is allowed to access selective statistics.

Returns:

true if the selective statistics privilege is held by the user

hasBackendVariablePrivilege

public boolean hasBackendVariablePrivilege()

Returns true if this user is allowed to create and modify backend variables.

Returns:

Boolean indicating if the user is allowed to create and modify backend variables.

getTranslator

public com.uc4.translate.Message getTranslator()

Returns the message translator.

Returns:

message translator

getClient

public java.lang.String getClient()

Returns:

UC4 Client

getDepartment

public java.lang.String getDepartment()

Returns:

UC4 Department

getLanguage

public java.lang.String getLanguage()

Returns:

Language: D,E or F

isValid

public boolean isValid()

Returns true if this connection is valid.

Returns:

Connection status

getPassword

public java.lang.String getPassword()

Returns:

Password of the UC4 User

getKerberosToken

public byte[] getKerberosToken()

Returns the kerberos token.

Returns:

Token for SSO

getSpnegoToken

public java.lang.String getSpnegoToken()

Returns the browser token.

Returns:

Token for SSO

getWFRunID

public long getWFRunID()

Returns the ARA Workflow ID. Internal use only.

Returns:

RunID of a Workflow

getSessionId

public java.lang.String getSessionId()

Returns:

SessionId

getSystemName

public java.lang.String getSystemName()

Returns:

Name of the UC4 System

getUserIdnr

public java.lang.String getUserIdnr()

Returns:

Internal User ID

getUserName

public java.lang.String getUserName()

Returns:

Name of the UC4 User

getEncoding

public java.lang.String getEncoding()

Returns the encoding used for communication between API and CP.

Returns:

used encoding

getDefaultJobPlanElse

public int getDefaultJobPlanElse()

Returns the default JobPlan task ELSE Action.

Returns:

Integer containing the JobPlan Task ELSE Action.

isSSO

public boolean isSSO()

Returns true if single sign on is active.

Returns:

Single sign on

getRemoteID

public java.lang.String getRemoteID()

Returns the remote ID.

Returns:

remote ID

getPasswordType

public java.lang.String getPasswordType()

Returns the type of the secret if the defined in the Connection.open() method.

Returns:

ET (Exit token), TK (Token) or PW (Password) or null if not set.

getSessionTimeZone

public java.util.TimeZone getSessionTimeZone()

Gets the session time zone.

Returns:

the session time zone

getKicks

public java.lang.String getKicks()

This connection is registered to receive the kick messages returned by this procedure. Kick messages are sent from the AE to the connected client when certain events occur in the AE.

Returns:

Comma separated list of kick messages.