de.espirit.firstspirit.access.project

Class RemoteProjectConfiguration

java.lang.Object

de.espirit.firstspirit.access.project.RemoteProjectConfiguration

All Implemented Interfaces:

Serializable, Cloneable

public class RemoteProjectConfiguration
extends Object
implements Serializable, Cloneable

This class holds all necessary information for a connection to a remote project. A remote project configuration can be defined in a project.

Since:

3.1.175

See Also:

Project.getRemoteProjectConfigurations(), Project.setRemoteProjectConfigurations(java.util.List), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_DEFAULT
static String	CATEGORY_PREFIX

Constructor Summary

Constructors

Constructor and Description
RemoteProjectConfiguration() Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLoginName() Returns the login name of the user which is used for the connection to the remote project or null if thecurrent user should be used.
String	getLoginPassword() Returns the password hash of the user which is used for the connection to the remote project or null if thecurrent user should be used.
String	getPrefix() Returns the prefix defined in this remote project configuration.
String	getProjectCategory() Returns the name of the project category (exclusive the prefix "category:") related to this configuration.
String	getProjectName() Returns the name of the project related to this configuration.
String	getSymbolicName() Returns the symbolic name of this remote project configuration.
String	getUrlCreator() Get the public or class name of the url creator used to generate urls to nodes of the remote project.
void	setLoginName(String loginName) Deprecated. since 5.0.100 - use setLoginUser(User,String) instead
void	setLoginPassword(String loginPassword) Deprecated. since 5.0.100 - use setLoginUser(User,String) instead
void	setLoginUser(User user, String loginPassword) Sets the user and password which should be used for the remote project connection.
void	setPrefix(String prefix) Sets the prefix for this remote project configuration.
void	setProjectCategory(String projectCategory) Set the name of the project category, for example "myRemoteCategory" not ""category:myRemoteCategory".
void	setProjectName(String projectName) Set the name of the project which should be related to this configuration.
void	setSymbolicName(String symbolicName) Set the symbolic name for this configuration.
void	setUrlCreator(String value) Set the public name or class name of the url creator used to generate urls for nodes of the remote project.
void	setUseCurrentUser(boolean useCurrentUser) Set true if the credentials of the current user should be used for the remote connection instead of the login name and the password hash.
void	setUseRelatedProjects(boolean useRelatedProjects)
void	setUseRemoteMedia(boolean useRemoteMedia)
void	setUseRemoteSchemata(boolean useRemoteSchemata)
String	toString()
boolean	useCurrentUser() Returns true if the remote connection which is created with thisremote project configuration should use the credentials of the current user instead of the login name and the password
boolean	useRelatedProjects()
boolean	useRemoteMedia()
boolean	useRemoteSchemata()

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_PREFIX

public static final String CATEGORY_PREFIX

Since:

4.2.9

See Also:

Constant Field Values

CATEGORY_DEFAULT

public static final String CATEGORY_DEFAULT

Since:

4.2.9

See Also:

Constant Field Values

Constructor Detail

RemoteProjectConfiguration

public RemoteProjectConfiguration()

Create a new instance.

Since:

3.1.175

Method Detail

getSymbolicName

public String getSymbolicName()

Returns the symbolic name of this remote project configuration. The returned name is unique for all remote project configurations known in the project.

Returns:

the unique symbolic name

Since:

3.1.175

setSymbolicName

public void setSymbolicName(String symbolicName)

Set the symbolic name for this configuration. Ensure that the given name is unique for all remote project configurations known in the project (Project.getRemoteProjectConfigurations())

Parameters:

symbolicName - the symbolic name for this configuration

Since:

3.1.175

getProjectName

public String getProjectName()

Returns the name of the project related to this configuration.

Returns:

the name of the project related to this configuration

Since:

3.1.175

setProjectName

public void setProjectName(String projectName)

Set the name of the project which should be related to this configuration.

Parameters:

projectName - the name of the project

Since:

3.1.175

getProjectCategory

@Nullable
public String getProjectCategory()

Returns the name of the project category (exclusive the prefix "category:") related to this configuration.

Returns:

the name of the project category (exlusive the prefix "category:") related to this configuration, e. g. "myRemoteCategory" not ""category:myRemoteCategory"

Since:

4.1

setProjectCategory

public void setProjectCategory(@Nullable
                      String projectCategory)

Set the name of the project category, for example "myRemoteCategory" not ""category:myRemoteCategory".

Parameters:

projectCategory - the project category string

Since:

4.1

getPrefix

public String getPrefix()

Returns the prefix defined in this remote project configuration. The prefix is used for generation of a link to a node in the remote project.

Returns:

the prefix used for generation of a link to a node in the remote project

Since:

3.1.175

setPrefix

public void setPrefix(String prefix)

Sets the prefix for this remote project configuration. The given prefix is used for generation of a link to a node in the remote project.

Parameters:

prefix -

Since:

3.1.175

getLoginName

public String getLoginName()

Returns the login name of the user which is used for the connection to the remote project or null if thecurrent user should be used.

Returns:

the login name of the user used for the remote project connection

Since:

3.1.175

See Also:

useCurrentUser()

setLoginName

@Deprecated
public void setLoginName(String loginName)

Deprecated. since 5.0.100 - use setLoginUser(User,String) instead

Always throws UnsupportedOperationException. Use setLoginUser(User,String) instead.

Parameters:

loginName - ignored parameter

Since:

3.1.175

See Also:

setUseCurrentUser(boolean)

getLoginPassword

public String getLoginPassword()

Returns the password hash of the user which is used for the connection to the remote project or null if thecurrent user should be used.

Returns:

the password hash of the user used for the remote project connection

Since:

3.1.175

See Also:

useCurrentUser()

setLoginPassword

@Deprecated
public void setLoginPassword(String loginPassword)

Deprecated. since 5.0.100 - use setLoginUser(User,String) instead

Always throws UnsupportedOperationException. Use setLoginUser(User,String) instead.

Parameters:

loginPassword - ignored parameter

Since:

3.1.175

See Also:

setUseCurrentUser(boolean)

setLoginUser

public void setLoginUser(@NotNull
                User user,
                @NotNull
                String loginPassword)

Sets the user and password which should be used for the remote project connection.

Parameters:

user - the user which should be used

loginPassword - the password of the user used for the remote project connection

Since:

5.0.100

See Also:

setUseCurrentUser(boolean)

useCurrentUser

public boolean useCurrentUser()

Returns true if the remote connection which is created with thisremote project configuration should use the credentials of the current user instead of the login name and the password

Returns:

true if the current user should be used for remote connection, false otherwise

Since:

4.0.17

setUseCurrentUser

public void setUseCurrentUser(boolean useCurrentUser)

Set true if the credentials of the current user should be used for the remote connection instead of the login name and the password hash.

Parameters:

useCurrentUser - true to use current user for remote connection, false otherwise

Since:

4.0.17

useRemoteMedia

public boolean useRemoteMedia()

Since:

4.0.26

setUseRemoteMedia

public void setUseRemoteMedia(boolean useRemoteMedia)

Since:

4.0.26

useRelatedProjects

public boolean useRelatedProjects()

Since:

4.0.26

setUseRelatedProjects

public void setUseRelatedProjects(boolean useRelatedProjects)

Since:

4.0.26

useRemoteSchemata

public boolean useRemoteSchemata()

Since:

4.0.26

setUseRemoteSchemata

public void setUseRemoteSchemata(boolean useRemoteSchemata)

Since:

4.0.26

getUrlCreator

public String getUrlCreator()

Get the public or class name of the url creator used to generate urls to nodes of the remote project.

Since:

4.1.27

See Also:

setUrlCreator(String)

setUrlCreator

public void setUrlCreator(String value)

Set the public name or class name of the url creator used to generate urls for nodes of the remote project.

Since:

4.1.27

See Also:

getUrlCreator()

toString

public String toString()

Overrides:

toString in class Object

Since:

3.1.175