Package org.quartz.management

Class ManagementRESTServiceConfiguration

  • public class ManagementRESTServiceConfiguration
extends java.lang.Object
    Configuration class of management REST services.
    Author:
    Ludovic Orban TODO : could be merged with ehcache ManagementRESTServiceConfiguration in a common module

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_BIND
      Default bind value.
      static int DEFAULT_SECURITY_SVC_TIMEOUT
      Default timeout for the connection to the configured security service

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getBind()
      Get the host:port pair to which the REST server should be bound.
      java.lang.String getHost()
      Get the host part of the host:port pair to which the REST server should be bound.
      int getPort()
      Get the port part of the host:port pair to which the REST server should be bound.
      java.lang.String getSecurityServiceLocation()
      Returns the security service location required for trusted identity assertion to the embedded REST management service.
      int getSecurityServiceTimeout()
      Returns the connection/read timeout value for the security service in milliseconds.
      boolean isEnabled()
      Check if the REST services should be enabled or not.
      void setBind​(java.lang.String bind)
      Set the host:port pair to which the REST server should be bound.
      void setEnabled​(boolean enabled)
      Set that the REST services should be enabled or disabled.
      void setSecurityServiceLocation​(java.lang.String securityServiceURL)
      Sets the security service location required for trusted identity assertion to the embedded REST management service.
      void setSecurityServiceTimeout​(int securityServiceTimeout)
      Sets the connection/read timeout value for the security service in milliseconds.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_BIND

        public static final java.lang.String DEFAULT_BIND
        Default bind value.
        See Also:
        Constant Field Values

      • DEFAULT_SECURITY_SVC_TIMEOUT

        public static final int DEFAULT_SECURITY_SVC_TIMEOUT
        Default timeout for the connection to the configured security service
        See Also:
        Constant Field Values

    • Constructor Detail

      • ManagementRESTServiceConfiguration

        public ManagementRESTServiceConfiguration()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Check if the REST services should be enabled or not.
        Returns:
        true if REST services should be enabled.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Set that the REST services should be enabled or disabled.
        Parameters:
        enabled - true if the REST services should be enabled.

      • getSecurityServiceLocation

        public java.lang.String getSecurityServiceLocation()
        Returns the security service location required for trusted identity assertion to the embedded REST management service. This feature is only available with an enterprise license.

        If this value is set, then this service will require secure dialog with the TMS or other 3rd party REST client implementations. The service furnished by the enterprise version of the TMC is located is provided at /api/assertIdentity.

        Returns:
        a string representing the URL of the security service.

      • setSecurityServiceLocation

        public void setSecurityServiceLocation​(java.lang.String securityServiceURL)
        Sets the security service location required for trusted identity assertion to the embedded REST management service. This feature is only available with an enterprise license.

        If this value is set, then this service will require secure dialog with the TMS or other 3rd party REST client implementations. The service furnished by the enterprise version of the TMC is located is provided at /api/assertIdentity.

        Parameters:
        securityServiceURL - a string representing the URL of the security service.

      • getSecurityServiceTimeout

        public int getSecurityServiceTimeout()
        Returns the connection/read timeout value for the security service in milliseconds.
        Returns:
        security service timeout

      • setSecurityServiceTimeout

        public void setSecurityServiceTimeout​(int securityServiceTimeout)
        Sets the connection/read timeout value for the security service in milliseconds.
        Parameters:
        securityServiceTimeout - milliseconds to timeout

      • getBind

        public java.lang.String getBind()
        Get the host:port pair to which the REST server should be bound. Format is: [IP address|host name]:[port number]
        Returns:
        the host:port pair to which the REST server should be bound.

      • getHost

        public java.lang.String getHost()
        Get the host part of the host:port pair to which the REST server should be bound.
        Returns:
        the host part of the host:port pair to which the REST server should be bound.

      • getPort

        public int getPort()
        Get the port part of the host:port pair to which the REST server should be bound.
        Returns:
        the port part of the host:port pair to which the REST server should be bound.

      • setBind

        public void setBind​(java.lang.String bind)
        Set the host:port pair to which the REST server should be bound.
        Parameters:
        bind - host:port pair to which the REST server should be bound.