Package org.odpi.openmetadata.adminservices.configuration.properties

Class BasicServerProperties

java.lang.Object
org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
org.odpi.openmetadata.adminservices.configuration.properties.BasicServerProperties
Direct Known Subclasses:
OMAGServerConfig, ServerPropertiesRequestBody
public class BasicServerProperties extends AdminServicesConfigHeader
ServerPropertiesRequestBody is the request body to add the basic server properties to an OMAG Server's configuration document.

  • Field Details

    • defaultLocalServerType

      public static final String defaultLocalServerType

    • defaultMaxPageSize

      public static final int defaultMaxPageSize
      See Also:

  • Constructor Details

    • BasicServerProperties

      public BasicServerProperties()
      Default constructor.

    • BasicServerProperties

      public BasicServerProperties(BasicServerProperties template)
      Copy/clone constructor.
      Parameters:
      template - object to copy

  • Method Details

    • getLocalServerDescription

      public String getLocalServerDescription()
      Return the description of the local server.
      Returns:
      String server description

    • setLocalServerDescription

      public void setLocalServerDescription(String localServerDescription)
      Set up the description of the local server.
      Parameters:
      localServerDescription - String local server description

    • getOrganizationName

      public String getOrganizationName()
      Return the name of the organization that is running the server.
      Returns:
      String organization name

    • setOrganizationName

      public void setOrganizationName(String organizationName)
      Set up the name of the organization that is running the server.
      Parameters:
      organizationName - String organization name

    • getLocalServerURL

      public String getLocalServerURL()
      Return the base URL for calling the local server.
      Returns:
      String URL

    • setLocalServerURL

      public void setLocalServerURL(String localServerURL)
      Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces. Typically, this is the URL root of the OMAG Server Platform Where the server is deployed to. However, it may be a DNS name - particularly if the server is deployed to multiple platforms for high availability (HA). The default value is "https://localhost:9443".
      Parameters:
      localServerURL - String URL

    • getLocalServerUserId

      public String getLocalServerUserId()
      Return the userId that the local server should use when processing events and there is no external user driving the operation.
      Returns:
      user id

    • setLocalServerUserId

      public void setLocalServerUserId(String localServerUserId)
      Set up the userId that the local server should use when processing events and there is no external user driving the operation.
      Parameters:
      localServerUserId - string user id

    • getLocalServerType

      public String getLocalServerType()
      Return the descriptive name for the server type.
      Returns:
      String server type

    • setLocalServerType

      public void setLocalServerType(String localServerType)
      Set up the descriptive name for the server type.
      Parameters:
      localServerType - String server type

    • getSecretsStoreProvider

      public String getSecretsStoreProvider()
      Return the class name of the secrets store provider.
      Returns:
      string

    • setSecretsStoreProvider

      public void setSecretsStoreProvider(String secretsStoreProvider)
      Set up the class name of the secrets store provider.
      Parameters:
      secretsStoreProvider - string

    • getSecretsStoreLocation

      public String getSecretsStoreLocation()
      Return the location information for the secrets store - this is stored in the endpoint network address for the secrets store connector.
      Returns:
      string

    • setSecretsStoreLocation

      public void setSecretsStoreLocation(String secretsStoreLocation)
      Set up the location information for the secrets store - this is stored in the endpoint network address for the secrets store connector.
      Parameters:
      secretsStoreLocation - string

    • getSecretsStoreCollection

      public String getSecretsStoreCollection()
      Return the secrets collection to use for the connection to the remote server.
      Returns:
      string

    • setSecretsStoreCollection

      public void setSecretsStoreCollection(String secretsStoreCollection)
      Set up the secrets collection to use for the connection to the remote server.
      Parameters:
      secretsStoreCollection - string

    • getMaxPageSize

      public int getMaxPageSize()
      Return the maximum page size supported by this server.
      Returns:
      int number of elements

    • setMaxPageSize

      public void setMaxPageSize(int maxPageSize)
      Set up the maximum page size supported by this server.
      Parameters:
      maxPageSize - int number of elements

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code