Class MechanismServer

  • All Implemented Interfaces:
    com.portwise.core.storage.StorageEntity, com.portwise.core.storage.Upgradeable, java.io.Serializable

    public class MechanismServer
    extends com.portwise.core.storage.SuperStorageEntity
    This persistent class holds information about an Authentication Server for an authentication method.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int[] RESTRICT_DIRECTLY
      Restrictions of this storage entity.
      static int[] RESTRICT_INDIRECTLY
      Restrictions of this storage entity.
    • Constructor Summary

      Constructors 
      Constructor Description
      MechanismServer()
      Constructs a new empty MechanismServer instance.
      MechanismServer​(java.lang.String host, int port, int timeout)
      Constructs a new MechanismServer instance with the specified parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHost()
      Returns the host name or IP address of the Authentication Server.
      java.lang.String getIndexedName()
      Returns the indexed name, which is the same as the entity key.
      java.util.Vector<MechanismConfiguration> getMechanismConfigurationList()
      Returns the configuration (key-value list) for the Authentication Server.
      int getPort()
      Returns the listening port of the Authentication Server.
      int getTimeout()
      Returns the time-out in milliseconds for the Authentication Server.
      void setHost​(java.lang.String host)
      Sets the host name or IP address of the Authentication Server.
      void setIndexedName​(java.lang.String name)
      Setting the indexed name has no effect.
      void setMechanismConfigurationList​(java.util.Vector<MechanismConfiguration> configurationList)
      Sets the configuration (key-value list) for the Authentication Server.
      void setPort​(int port)
      Sets the listening port of the Authentication Server.
      void setTimeout​(int timeout)
      Sets the time-out in milliseconds for the Authentication Server.
      java.lang.String toString()  
      • Methods inherited from class com.portwise.core.storage.SuperStorageEntity

        getKey, getNewRevision, getOldRevision, getSecurityEntityException, getTransactionKey, initialized, load, loadByType, remove, remove, setKey, setOldRevision, setSecurityEntityException, setTransactionKey, store, store, storeMultiple, storeMultiple, upgrade
      • Methods inherited from class java.lang.Object

        clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • RESTRICT_DIRECTLY

        public static final int[] RESTRICT_DIRECTLY
        Restrictions of this storage entity.
      • RESTRICT_INDIRECTLY

        public static final int[] RESTRICT_INDIRECTLY
        Restrictions of this storage entity.
    • Constructor Detail

      • MechanismServer

        public MechanismServer()
        Constructs a new empty MechanismServer instance.
      • MechanismServer

        public MechanismServer​(java.lang.String host,
                               int port,
                               int timeout)
        Constructs a new MechanismServer instance with the specified parameters.
        Parameters:
        host - The host name or IP address of the Authentication Server.
        port - The listening port of the Authentication Server.
        timeout - The time-out in milliseconds for the Authentication Server.
    • Method Detail

      • getHost

        public java.lang.String getHost()
        Returns the host name or IP address of the Authentication Server.
        Returns:
        The host name or IP address of the Authentication Server.
      • setHost

        public void setHost​(java.lang.String host)
        Sets the host name or IP address of the Authentication Server.
        Parameters:
        host - The host name or IP address of the Authentication Server.
      • getPort

        public int getPort()
        Returns the listening port of the Authentication Server.
        Returns:
        The listening port of the Authentication Server.
      • setPort

        public void setPort​(int port)
        Sets the listening port of the Authentication Server.
        Parameters:
        port - The listening port of the Authentication Server.
      • getTimeout

        public int getTimeout()
        Returns the time-out in milliseconds for the Authentication Server.
        Returns:
        The time-out in milliseconds for the Authentication Server.
      • setTimeout

        public void setTimeout​(int timeout)
        Sets the time-out in milliseconds for the Authentication Server.
        Parameters:
        timeout - The time-out in milliseconds for the Authentication Server.
      • getMechanismConfigurationList

        public java.util.Vector<MechanismConfiguration> getMechanismConfigurationList()
        Returns the configuration (key-value list) for the Authentication Server. The key-value list consists of MechanismConfiguration instances.
        Returns:
        The configuration (key-value list) for the Authentication Server.
      • setMechanismConfigurationList

        public void setMechanismConfigurationList​(java.util.Vector<MechanismConfiguration> configurationList)
        Sets the configuration (key-value list) for the Authentication Server. The key-value list must consist of MechanismConfiguration instances.
        Parameters:
        configurationList - The configuration (key-value list) for the Authentication Server.
      • getIndexedName

        public java.lang.String getIndexedName()
        Returns the indexed name, which is the same as the entity key.
        Specified by:
        getIndexedName in interface com.portwise.core.storage.StorageEntity
        Overrides:
        getIndexedName in class com.portwise.core.storage.SuperStorageEntity
        Returns:
        The indexed name (entity key).
        See Also:
        StorageEntity.getIndexedName()
      • setIndexedName

        public void setIndexedName​(java.lang.String name)
        Setting the indexed name has no effect.
        Specified by:
        setIndexedName in interface com.portwise.core.storage.StorageEntity
        Overrides:
        setIndexedName in class com.portwise.core.storage.SuperStorageEntity
        Parameters:
        name - The indexed name (not used).
        See Also:
        StorageEntity.setIndexedName(java.lang.String)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()