Package org.odpi.openmetadata.adminservices.rest

Class ServerPropertiesRequestBody

java.lang.Object
org.odpi.openmetadata.adminservices.rest.ServerPropertiesRequestBody
public class ServerPropertiesRequestBody extends Object
ServerPropertiesRequestBody is the request body to add the basic server properties to an OMAG Server's configuration document.

  • Constructor Details

    • ServerPropertiesRequestBody

      public ServerPropertiesRequestBody()
      Default constructor.

    • ServerPropertiesRequestBody

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

    • getLocalServerPassword

      public String getLocalServerPassword()
      Return the password that the local server should use on outbound REST calls (this is the password for the localServerUserId). Using userId's and passwords for server authentication is not suitable for production environments.
      Returns:
      password in clear

    • setLocalServerPassword

      public void setLocalServerPassword(String localServerPassword)
      Set up the password that the local server should use on outbound REST calls (this is the password for the localServerUserId). Using userId's and passwords for server authentication is not suitable for production environments.
      Parameters:
      localServerPassword - password in clear

    • 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