Package se.curity.identityserver.sdk.config.annotation

package se.curity.identityserver.sdk.config.annotation
This package contains annotations that may be used by Configuration interfaces to provide extra information about configuration values.

The information provided by the Java types is used to the extent possible. For example, an Optional value is made optional in the configuration service, a List value can receive 0-N values.

The annotations in this package allow plugin authors to provide information that is impossible to provide using only the Java type-system, such as the minimum-maximum size a List or String may take, the minimum/maximum magnitude of a numeric value, and the pattern a String value must follow to be acceptable.

As an example, the length of a List can be constrained with the SizeConstraint annotation.

A default value may be provided for a value simply by annotating the relevant method of the configuration interface with one of the Default value annotations in this package.

The name of an element may be provided by the Name annotation. This allows de-coupling the Java name from the configuration name. See Name for more details.

See Also:
  • Annotation Interfaces
    Class
    Description
    DefaultBoolean
    Provides a default value for a boolean configuration item.
    DefaultDouble
    Provides a default value for a double configuration item.
    DefaultEnum
    Provides the default enum value that should be used for a method which returns a Java enum or the type argument of an Optional where that type is an enum.
    DefaultInteger
    Provides a default value for a integer configuration item.
    DefaultLong
    Provides a default value for a long configuration item.
    DefaultOption
    Annotates the default option that should be used within a OneOf interface.
    DefaultString
    Provides a default value for a String configuration item.
    DefaultURI
    Provides a default value for a URI configuration item.
    Description
    Defines a description for a configuration item.
    ListKey
    Marks an element as being part of a list item key.
    Name
    Defines the name of a configuration item.
    PatternConstraint
    Constrains the values a configuration element of type String may take.
    PrecisionConstraint
    Constrains the Fraction Precision of the value the element can take.
    RangeConstraint
    Constrains an element's numeric value to within a certain range.
    SizeConstraint
    Constrains a configuration element's size.
    Suggestions
    Special annotation available for use on methods returning String (including Optional<String>) values.