public final class RemoteProjectConfiguration extends Object implements Serializable, Cloneable
Project.getRemoteProjectConfigurations()
,
Project.setRemoteProjectConfigurations(java.util.List)
,
Serialized FormModifier and Type | Field and Description |
---|---|
static String |
CATEGORY_DEFAULT
The default category name.
|
static String |
CATEGORY_PREFIX
Prefix for category descriptors.
|
Constructor and Description |
---|
RemoteProjectConfiguration()
Create a new instance.
|
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 the current 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 the current 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)
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.
|
String |
toString()
Provides a textual representation for this configuration.
|
boolean |
useCurrentUser()
Returns
true if the remote connection which is created with this remote project configuration should use the credentials of thecurrent user instead of the login name and the password |
boolean |
useRelatedProjects()
Indicates whether to use related projects.
|
boolean |
useRelease()
Indicates whether or not a released version of store elements is required for referencing.
|
boolean |
useRemoteMedia()
Indicates whether to use remote media.
|
boolean |
useRemoteSchemata()
Indicates whether to use remote schemata.
|
public static final String CATEGORY_PREFIX
public static final String CATEGORY_DEFAULT
public RemoteProjectConfiguration()
public String getSymbolicName()
public void setSymbolicName(String symbolicName)
Project.getRemoteProjectConfigurations()
)symbolicName
- the symbolic name for this configurationpublic String getProjectName()
public void setProjectName(String projectName)
projectName
- the name of the project@Nullable public String getProjectCategory()
public void setProjectCategory(@Nullable String projectCategory)
projectCategory
- the project category stringpublic String getPrefix()
public void setPrefix(String prefix)
prefix
- public String getLoginName()
null
if the current user
should be used.useCurrentUser()
@Deprecated public void setLoginName(String loginName)
setLoginUser(User,String)
insteadUnsupportedOperationException
. Use setLoginUser(User,String)
instead.loginName
- ignored parametersetUseCurrentUser(boolean)
public String getLoginPassword()
null
if the current user
should be used.useCurrentUser()
@Deprecated public void setLoginPassword(String loginPassword)
setLoginUser(User,String)
insteadUnsupportedOperationException
. Use setLoginUser(User,String)
instead.loginPassword
- ignored parametersetUseCurrentUser(boolean)
public void setLoginUser(@NotNull User user, @NotNull String loginPassword)
user
- the user which should be usedloginPassword
- the password of the user used for the remote project connectionsetUseCurrentUser(boolean)
public boolean useCurrentUser()
true
if the remote connection which is created with this remote project configuration
should use the credentials of thecurrent user instead of the login name
and the password
true
if the current user should be used for remote connection, false
otherwisepublic void setUseCurrentUser(boolean useCurrentUser)
true
if the credentials of the current user should be used for the remote connection instead of the login name
and the password hash
.useCurrentUser
- true
to use current user for remote connection, false
otherwisepublic boolean useRemoteMedia()
true
, if using remote media.public void setUseRemoteMedia(boolean useRemoteMedia)
useRemoteMedia
- true
, to enable using remote media.public boolean useRelatedProjects()
true
, if using related projects.public void setUseRelatedProjects(boolean useRelatedProjects)
useRelatedProjects
- true
, to enable using related projects.public boolean useRemoteSchemata()
true
, if using remote schemata.public void setUseRemoteSchemata(boolean useRemoteSchemata)
useRemoteSchemata
- true
, to enable using remote schemata.public boolean useRelease()
public void setUseRelease(boolean useRelease)
useRelease
- true
if a released version of store elements is required for referencing, false
otherwise.public String getUrlCreator()
setUrlCreator(String)
public void setUrlCreator(String value)
getUrlCreator()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210