Package com.sodius.oslc.server.oauth.model

Enum FriendState

  • All Implemented Interfaces:
    Serializable, Comparable<FriendState>
    public enum FriendState
extends Enum<FriendState>
    Represents the state of an OSLC friend:
    • UNEXPECTED_ERROR - An error occurred when computing the state.
    • OFFLINE - A connection with the friend server cannot be established, typically when the host is unknown.
    • DOWN - Friend server is reachable but root services resource cannot be retrieved for any reason.
    • REJECTING - Friend server is up and running but is rejecting the consumer information.
    • OK - Friend server is reachable and accepting the consumer information.
    Since:
    2.0

    • Enum Constant Detail

      • UNEXPECTED_ERROR

        public static final FriendState UNEXPECTED_ERROR
        An error occurred when computing the state.

      • OFFLINE

        public static final FriendState OFFLINE
        A connection with the friend server cannot be established, typically when the host is unknown.

      • DOWN

        public static final FriendState DOWN
        Friend server is reachable but root services resource cannot be retrieved for any reason.

      • REJECTING

        public static final FriendState REJECTING
        Friend server is up and running but is rejecting the consumer information.

      • MISMATCH

        public static final FriendState MISMATCH
        Friend server is up and running but returned domain mismatches the registered one.
        Since:
        3.4.0

      • OK

        public static final FriendState OK
        Friend server is reachable and accepting the consumer information.

      • REHOSTING

        public static final FriendState REHOSTING
        Friend server is reachable but a re-hosting process is undergoing.
        Since:
        3.1.1

      • SSL_ERROR

        public static final FriendState SSL_ERROR
        Friend server is reachable but an SSL error stopped the authentication process
        Since:
        3.7.0

      • MISSING_FRIEND

        public static final FriendState MISSING_FRIEND
        No Friend was found.
        Since:
        3.7.0

    • Method Detail

      • values

        public static FriendState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FriendState c : FriendState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FriendState valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null