com.microfocus.silkcentral.webservices.system

Class SystemService

java.lang.Object

com.microfocus.silkcentral.webservices.system.SystemService

public class SystemService
extends java.lang.Object

System service. Provides an authentication method and simple utility methods.

Constructor Summary

Constructors

Constructor and Description
SystemService()

Method Summary

Modifier and Type	Method and Description
long	convertFromReadableTime(java.lang.String time) Converts the given date/time to the number of milliseconds since midnight, January 1, 1970 UTC.
java.lang.String	convertToReadableTime(long time) Converts the given time (number of milliseconds since midnight, January 1, 1970 UTC) into a human-readable string representation.
java.lang.String	getRepositoryInstanceID(java.lang.String sessionId) Retrieves the repository instance ID that was defined when the repository was created.
boolean	keepAlive(java.lang.String sessionId) Keep session alive
java.lang.String	logonUser(java.lang.String username, java.lang.String plainPwd) Logs on with a given username and password.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemService

public SystemService()

Method Detail

logonUser

public java.lang.String logonUser(java.lang.String username,
                                  java.lang.String plainPwd)
                           throws WSFaultException

Logs on with a given username and password. The returned session identifier can be used in subsequent calls. The session created with the method expires when it is not used for a period of time.
Note: When accessing Silk Central through web-service calls, Micro Focus recommends using a web-service token instead of a session identifier for authenticating. You can generate a web-service token in the Silk Central UI.

Parameters:

username - the login username

plainPwd - the password of the specified username

Returns:

a unique identifier (used as a key) identifying the session created with the method

Throws:

WSFaultException - if logon fails

convertToReadableTime

public java.lang.String convertToReadableTime(long time)

Converts the given time (number of milliseconds since midnight, January 1, 1970 UTC) into a human-readable string representation. The format returned is "YYYY-MM-DD HH:MM:SS.MMM".

Parameters:

time - The time to convert (specified in milliseconds since midnight, January 1, 1970 UTC).

Returns:

Human-readable string representation of the given time (based on UTC!).

convertFromReadableTime

public long convertFromReadableTime(java.lang.String time)

Converts the given date/time to the number of milliseconds since midnight, January 1, 1970 UTC.

Parameters:

time - Date/time to be converted (based on UTC!) using the format "YYYY-MM-DD HH:MM:SS.MMM"

Returns:

Number of milliseconds since midnight, January 1, 1970 UTC

getRepositoryInstanceID

public java.lang.String getRepositoryInstanceID(java.lang.String sessionId)
                                         throws WSFaultException

Retrieves the repository instance ID that was defined when the repository was created. A repository ID is used in ALM URIs to uniquely identify Test Manager requirements and test definitions across multiple Test Manager repositories.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

the repository instance ID

Throws:

WSFaultException - if an error occurred.

keepAlive

public boolean keepAlive(java.lang.String sessionId)
                  throws WSFaultException

Keep session alive

Parameters:

sessionId - the unique ID of the session created with logonUser(String, String)

Throws:

WSFaultException