Package org.jgroups.auth

Class FixedMembershipToken

  • All Implemented Interfaces:
    Streamable
    public class FixedMembershipToken
extends AuthToken

    The FixedMemberShipToken object predefines a list of IP addresses and ports that can join the group.

    Configuration parameters for this example are shown below:

    • fixed_members_value (required) = List of IP addresses & ports (optionally) - ports must be seperated by a '/' e.g. 127.0.0.1/1010*127.0.0.1/4567
    • fixed_members_seperator (required) = The seperator used between IP addresses - e.g. *
    Author:
    Chris Mills (millsy@jboss.com)

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean authenticate​(AuthToken token, Message msg)
      This method should be implemented to perform the actual authentication of joining members.
      java.lang.String getName()
      Used to return the full package and class name of the implementation.
      boolean isInMembersList​(IpAddress sender)  
      static boolean match​(IpAddress sender, java.net.InetSocketAddress addr)  
      void readFrom​(java.io.DataInput in)
      Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
      void setFixedMembersSeparator​(java.lang.String value)  
      void setMemberList​(java.lang.String list)  
      int size()
      The size of the marshalled AuthToken
      void writeTo​(java.io.DataOutput out)
      Write the entire state of the current object (including superclasses) to outstream.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FixedMembershipToken

        public FixedMembershipToken()

      • FixedMembershipToken

        public FixedMembershipToken​(java.lang.String token)

    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: AuthToken
        Used to return the full package and class name of the implementation. This is used by the AUTH protocol to create an instance of the implementation.
        Specified by:
        getName in class AuthToken
        Returns:
        a java.lang.String object of the package and class name

      • setFixedMembersSeparator

        public void setFixedMembersSeparator​(java.lang.String value)

      • authenticate

        public boolean authenticate​(AuthToken token,
                            Message msg)
        Description copied from class: AuthToken
        This method should be implemented to perform the actual authentication of joining members.
        Specified by:
        authenticate in class AuthToken
        Parameters:
        token - the token sent by the joiner
        msg - the Message object containing the actual JOIN_REQ
        Returns:
        true if authenticaion passed or false if it failed.

      • isInMembersList

        public boolean isInMembersList​(IpAddress sender)

      • match

        public static boolean match​(IpAddress sender,
                            java.net.InetSocketAddress addr)

      • setMemberList

        public void setMemberList​(java.lang.String list)
                   throws java.net.UnknownHostException
        Throws:
        java.net.UnknownHostException

      • writeTo

        public void writeTo​(java.io.DataOutput out)
             throws java.io.IOException
        Description copied from interface: Streamable
        Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed
        Throws:
        java.io.IOException

      • readFrom

        public void readFrom​(java.io.DataInput in)
              throws java.io.IOException
        Description copied from interface: Streamable
        Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
        Throws:
        java.io.IOException

      • size

        public int size()
        Description copied from class: AuthToken
        The size of the marshalled AuthToken
        Specified by:
        size in class AuthToken