Class RemoteProjectConfiguration
java.lang.Object
de.espirit.firstspirit.access.project.RemoteProjectConfiguration
- All Implemented Interfaces:
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.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription@Nullable String
Returns the login name of the user which is used for the connection to the remote project ornull
if thecurrent user
should be used.@Nullable String
Returns the password hash of the user which is used for the connection to the remote project ornull
if thecurrent user
should be used.Returns the prefix defined in this remote project configuration.@Nullable String
Returns the name of the project category (exclusive the prefix "category:") related to this configuration.Returns the name of the project related to this configuration.Returns the symbolic name of this remote project configuration.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.void
setLoginPassword
(String loginPassword) Deprecated.since 5.0.100 - usesetLoginUser(User,String)
insteadvoid
setLoginUser
(@NotNull User user, @NotNull String loginPassword) Sets the user and password which should be used for the remote project connection.void
Sets the prefix for this remote project configuration.void
setProjectCategory
(@Nullable 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) Settrue
if the credentials of the current user should be used for the remote connection instead of thelogin name
and thepassword hash
.void
setUseRelatedProjects
(boolean useRelatedProjects) Defines whether to use related projects.void
setUseRelease
(boolean useRelease) Defines whether or not a released version of store elements is required for referencing.void
setUseRemoteMedia
(boolean useRemoteMedia) Defines whether to use remote media.void
setUseRemoteSchemata
(boolean useRemoteSchemata) Defines whether to use remote schemata.toString()
Provides a textual representation for this configuration.boolean
Returnstrue
if the remote connection which is created with thisremote project configuration
should use the credentials of thecurrent user instead of thelogin name
and thepassword
boolean
Indicates whether to use related projects.boolean
Indicates whether or not a released version of store elements is required for referencing.boolean
Indicates whether to use remote media.boolean
Indicates whether to use remote schemata.
-
Field Details
-
CATEGORY_PREFIX
Prefix for category descriptors.- Since:
- 4.2.9
- See Also:
-
CATEGORY_DEFAULT
The default category name.- Since:
- 4.2.9
- See Also:
-
-
Constructor Details
-
RemoteProjectConfiguration
public RemoteProjectConfiguration()Create a new instance.- Since:
- 3.1.175
-
-
Method Details
-
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
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
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
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
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
Set the name of the project category, for example "myRemoteCategory" not ""category:myRemoteCategory".- Parameters:
projectCategory
- the project category string- Since:
- 4.1
-
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
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
Returns the login name of the user which is used for the connection to the remote project ornull
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:
-
setLoginName
Deprecated.since 5.0.100 - usesetLoginUser(User,String)
insteadAlways throwsUnsupportedOperationException
. UsesetLoginUser(User,String)
instead.- Parameters:
loginName
- ignored parameter- Since:
- 3.1.175
- See Also:
-
getLoginPassword
Returns the password hash of the user which is used for the connection to the remote project ornull
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:
-
setLoginPassword
Deprecated.since 5.0.100 - usesetLoginUser(User,String)
insteadAlways throwsUnsupportedOperationException
. UsesetLoginUser(User,String)
instead.- Parameters:
loginPassword
- ignored parameter- Since:
- 3.1.175
- See Also:
-
setLoginUser
Sets the user and password which should be used for the remote project connection.- Parameters:
user
- the user which should be usedloginPassword
- the password of the user used for the remote project connection- Since:
- 5.0.100
- See Also:
-
useCurrentUser
public boolean useCurrentUser()Returnstrue
if the remote connection which is created with thisremote project configuration
should use the credentials of thecurrent user instead of thelogin name
and thepassword
- Returns:
true
if the current user should be used for remote connection,false
otherwise- Since:
- 4.0.17
-
setUseCurrentUser
public void setUseCurrentUser(boolean useCurrentUser) Settrue
if the credentials of the current user should be used for the remote connection instead of thelogin name
and thepassword hash
.- Parameters:
useCurrentUser
-true
to use current user for remote connection,false
otherwise- Since:
- 4.0.17
-
useRemoteMedia
public boolean useRemoteMedia()Indicates whether to use remote media.- Returns:
true
, if using remote media.- Since:
- 4.0.26
-
setUseRemoteMedia
public void setUseRemoteMedia(boolean useRemoteMedia) Defines whether to use remote media.- Parameters:
useRemoteMedia
-true
, to enable using remote media.- Since:
- 4.0.26
-
useRelatedProjects
public boolean useRelatedProjects()Indicates whether to use related projects.- Returns:
true
, if using related projects.- Since:
- 4.0.26
-
setUseRelatedProjects
public void setUseRelatedProjects(boolean useRelatedProjects) Defines whether to use related projects.- Parameters:
useRelatedProjects
-true
, to enable using related projects.- Since:
- 4.0.26
-
useRemoteSchemata
public boolean useRemoteSchemata()Indicates whether to use remote schemata.- Returns:
true
, if using remote schemata.- Since:
- 4.0.26
-
setUseRemoteSchemata
public void setUseRemoteSchemata(boolean useRemoteSchemata) Defines whether to use remote schemata.- Parameters:
useRemoteSchemata
-true
, to enable using remote schemata.- Since:
- 4.0.26
-
useRelease
public boolean useRelease()Indicates whether or not a released version of store elements is required for referencing.- Returns:
- Whether or not a released version of store elements is required for referencing.
- Since:
- 5.2.410
-
setUseRelease
public void setUseRelease(boolean useRelease) Defines whether or not a released version of store elements is required for referencing.- Parameters:
useRelease
-true
if a released version of store elements is required for referencing,false
otherwise.- Since:
- 5.2.410
-
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
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:
-
toString
Provides a textual representation for this configuration.
-
setLoginUser(User,String)
instead