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

Enum Class FriendState

java.lang.Object
java.lang.Enum<FriendState>
com.sodius.oslc.server.oauth.model.FriendState
All Implemented Interfaces:
Serializable, Comparable<FriendState>, java.lang.constant.Constable
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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DIFFERENT_DOMAIN
    Friend is on a different domain than the application.
    DOWN
    Friend server is reachable but root services resource cannot be retrieved for any reason.
    MISMATCH
    Friend server is up and running but returned domain mismatches the registered one.
    MISSING_FRIEND
    No Friend was found.
    NOT_FQDN
    Friend referenced by a non FQDN URI.
    OFFLINE
    A connection with the friend server cannot be established, typically when the host is unknown.
    OK
    Friend server is reachable and accepting the consumer information.
    REHOSTING
    Friend server is reachable but a re-hosting process is undergoing.
    REJECTING
    Friend server is up and running but is rejecting the consumer information.
    SSL_ERROR
    Friend server is reachable but an SSL error stopped the authentication process
    UNEXPECTED_ERROR
    An error occurred when computing the state.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FriendState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FriendState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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

    • NOT_FQDN

      public static final FriendState NOT_FQDN
      Friend referenced by a non FQDN URI.
      Since:
      3.12.0

    • DIFFERENT_DOMAIN

      public static final FriendState DIFFERENT_DOMAIN
      Friend is on a different domain than the application.
      Since:
      3.12.0

  • Method Details

    • values

      public static FriendState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FriendState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null