Class RemoteProjectConfiguration

java.lang.Object
de.espirit.firstspirit.access.project.RemoteProjectConfiguration
All Implemented Interfaces:
Serializable, Cloneable

public final 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:
  • Field Details

    • CATEGORY_PREFIX

      public static final String CATEGORY_PREFIX
      Prefix for category descriptors.
      Since:
      4.2.9
      See Also:
    • CATEGORY_DEFAULT

      public static final String 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

      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

      @Nullable public 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.
      Returns:
      the login name of the user used for the remote project connection
      Since:
      3.1.175
      See Also:
    • setLoginName

      @Deprecated public void setLoginName(String loginName)
      Deprecated.
      since 5.0.100 - use setLoginUser(User,String) instead
      Parameters:
      loginName - ignored parameter
      Since:
      3.1.175
      See Also:
    • getLoginPassword

      @Nullable public 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.
      Returns:
      the password hash of the user used for the remote project connection
      Since:
      3.1.175
      See Also:
    • setLoginPassword

      @Deprecated public void setLoginPassword(String loginPassword)
      Deprecated.
      since 5.0.100 - use setLoginUser(User,String) instead
      Parameters:
      loginPassword - ignored parameter
      Since:
      3.1.175
      See Also:
    • 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:
    • useCurrentUser

      public 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
      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()
      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

      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

      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:
    • toString

      public String toString()
      Provides a textual representation for this configuration.
      Overrides:
      toString in class Object
      Returns:
      A string.
      Since:
      3.1.175