com.arcway.cockpit.docgen.provider.interfaces

Interface IConfiguredServerConnection

public interface IConfiguredServerConnection

Represents a server configured on the client.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends ILockOnServer>	getAllLocksOnServer() Returns all locks set on the server.
java.util.Map<java.lang.String,IConfiguredProject>	getConfiguredProjects() Returns all currently configured projects of this server.
java.util.Map<java.lang.String,IServerGroup>	getGroups() Returns all groups available on this server.
java.util.Map<java.lang.String,IProjectOnServer>	getProjectsOnServer() Returns all projects stored on this server that are visible for the current user.
java.lang.String	getServerDumpAsFileName(java.lang.String fileNamePrefix, java.util.Collection<? extends java.lang.String> projectUIDsToExclude) Retrieves a server dump file from the server and returns the local file name.
java.lang.String	getServerID()
java.lang.String	getServerName()
java.lang.String	getServerURL()
java.lang.String	getUserDistinguishedName()
java.lang.String	getUserLoginID()
java.lang.String	getUserRealName()
java.util.Map<java.lang.String,IServerUser>	getUsers() Returns all users available on this server.
boolean	isConnected() Returns if the server is currently connected.
boolean	isSingleUserEnvironment() Returns true in a single user edition.

Method Detail

isSingleUserEnvironment

boolean isSingleUserEnvironment()

Returns true in a single user edition.

Returns:

true for single user edition

isConnected

boolean isConnected()

Returns if the server is currently connected.

Returns:

true if connected

getServerID

java.lang.String getServerID()

Returns:

server ID (may be null in a single user environment)

getServerName

java.lang.String getServerName()

Returns:

server name (may be null in a single user environment)

getServerURL

java.lang.String getServerURL()

Returns:

server URL (may be null in a single user environment)

getUserDistinguishedName

java.lang.String getUserDistinguishedName()

Returns:

user's distinguished name

getUserLoginID

java.lang.String getUserLoginID()

Returns:

user's login name

getUserRealName

java.lang.String getUserRealName()

Returns:

user's real name

getConfiguredProjects

java.util.Map<java.lang.String,IConfiguredProject> getConfiguredProjects()

Returns all currently configured projects of this server.

Returns:

map with project UID as key and the configured project as value

getProjectsOnServer

java.util.Map<java.lang.String,IProjectOnServer> getProjectsOnServer()
                                                              throws de.plans.psc.client.communication.ServerNotAvailableException,
                                                                     de.plans.psc.shared.serverexceptions.EXServerException,
                                                                     de.plans.psc.client.communication.LoginCanceledException,
                                                                     de.plans.psc.client.communication.UnknownServerException

Returns all projects stored on this server that are visible for the current user.

Returns:

map with project UID as key and the project as value

Throws:

de.plans.psc.client.communication.UnknownServerException

de.plans.psc.client.communication.LoginCanceledException

de.plans.psc.shared.serverexceptions.EXServerException

de.plans.psc.client.communication.ServerNotAvailableException

getUsers

java.util.Map<java.lang.String,IServerUser> getUsers()
                                              throws de.plans.psc.client.communication.ServerNotAvailableException,
                                                     de.plans.psc.shared.serverexceptions.EXServerException,
                                                     de.plans.psc.client.communication.LoginCanceledException,
                                                     de.plans.psc.client.communication.UnknownServerException

Returns all users available on this server.

Key: user name,
Value: user

Returns:

collection of all users (never null)

Throws:

de.plans.psc.client.communication.UnknownServerException

de.plans.psc.client.communication.LoginCanceledException

de.plans.psc.shared.serverexceptions.EXServerException

de.plans.psc.client.communication.ServerNotAvailableException

getGroups

java.util.Map<java.lang.String,IServerGroup> getGroups()
                                                throws de.plans.psc.client.communication.ServerNotAvailableException,
                                                       de.plans.psc.shared.serverexceptions.EXServerException,
                                                       de.plans.psc.client.communication.LoginCanceledException,
                                                       de.plans.psc.client.communication.UnknownServerException

Returns all groups available on this server.

Key: group name,
Value: group

Returns:

collection of all groups (never null)

Throws:

de.plans.psc.client.communication.UnknownServerException

de.plans.psc.client.communication.LoginCanceledException

de.plans.psc.shared.serverexceptions.EXServerException

de.plans.psc.client.communication.ServerNotAvailableException

getServerDumpAsFileName

java.lang.String getServerDumpAsFileName(java.lang.String fileNamePrefix,
                                         java.util.Collection<? extends java.lang.String> projectUIDsToExclude)

Retrieves a server dump file from the server and returns the local file name. The dump is loaded from the server and stored in a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

fileNamePrefix - prefix that is added to the file name

projectUIDsToExclude - UIDs of project to exclude from the dump (null or empty for all projects)

Returns:

absolute path name of the file (null in case of error, details are logged into the client logfile)

getAllLocksOnServer

java.util.Collection<? extends ILockOnServer> getAllLocksOnServer()
                                                           throws de.plans.psc.client.communication.ServerNotAvailableException,
                                                                  de.plans.psc.shared.serverexceptions.EXServerException,
                                                                  de.plans.psc.client.communication.LoginCanceledException,
                                                                  de.plans.psc.client.communication.UnknownServerException

Returns all locks set on the server.

Returns:

all locks (empty for none)

Throws:

de.plans.psc.client.communication.UnknownServerException

de.plans.psc.client.communication.LoginCanceledException

de.plans.psc.shared.serverexceptions.EXServerException

de.plans.psc.client.communication.ServerNotAvailableException