Package net.shibboleth.idp.plugin.oidc.op.token.support

Class RegistrationClaimsSet

  • public final class RegistrationClaimsSet
extends Object
    Class wrapping claims for the initial registration access token.

    • Field Detail

      • VALUE_TYPE_RT

        private static final String VALUE_TYPE_RT
        Value of initial registration access token claims set type.
        See Also:
        Constant Field Values

      • log

        @Nonnull
private org.slf4j.Logger log
        Class logger.

      • expiration

        @Nullable
private Instant expiration
        Expiration time of the token.

      • issuedAt

        @Nullable
private Instant issuedAt
        Issuance time of the token.

      • principal

        @Nullable
@NotEmpty
private String principal
        The principal who issued the token.

      • authContext

        @Nullable
@NotEmpty
private String authContext
        Authentication context class reference value of the performed authentication.

      • authTime

        @Nullable
private Instant authTime
        Authentication time of the performed authentication.

      • metadata

        @Nullable
@NonnullElements
private Map<String,​net.shibboleth.oidc.metadata.policy.MetadataPolicy> metadata
        Allowed metadata values to be issued with the token.

      • relyingPartyId

        @Nullable
@NotEmpty
private String relyingPartyId
        Relying party identifier.

      • replacement

        @Nullable
private Boolean replacement
        Flag to signal replacement is allowed.

    • Constructor Detail

      • RegistrationClaimsSet

        private RegistrationClaimsSet()
        Constructor.

    • Method Detail

      • getJti

        @Nullable
@NotEmpty
public String getJti()
        Get the identifier for the token.
        Returns:
        The identifier for the token.

      • setJti

        public void setJti​(@Nullable @NotEmpty
                   String id)
        Set the identifier for the token.
        Parameters:
        id - What to set.

      • getKeyType

        @Nullable
@NotEmpty
public String getKeyType()
        Get the type of the token.
        Returns:
        The type of the token.

      • setKeyType

        public void setKeyType​(@Nullable @NotEmpty
                       String type)
        Set the type of the token.
        Parameters:
        type - What to set.

      • getIssuer

        @Nullable
@NotEmpty
public String getIssuer()
        Get the issuer of the token.
        Returns:
        The issuer of the token.

      • setIssuer

        public void setIssuer​(@Nullable @NotEmpty
                      String iss)
        Set the issuer of the token.
        Parameters:
        iss - What to set.

      • getExpiration

        @Nullable
public Instant getExpiration()
        Get the expiration time of the token.
        Returns:
        The expiration time of the token.

      • setExpiration

        public void setExpiration​(@Nullable
                          Instant exp)
        Set the expiration time of the token.
        Parameters:
        exp - What to set.

      • getExpirationEpoch

        @NonNegative
public long getExpirationEpoch()
        Get the expiration time of the token using epoch seconds.
        Returns:
        The expiration time of the token using epoch seconds.

      • setExpirationEpoch

        public void setExpirationEpoch​(@NonNegative
                               long exp)
        Set the expiration time of the token using epoch seconds.
        Parameters:
        exp - What to set.

      • getIssuedAt

        @Nullable
public Instant getIssuedAt()
        Get the issuance time of the token.
        Returns:
        The issuance time of the token.

      • setIssuedAt

        public void setIssuedAt​(@Nullable
                        Instant iat)
        Set the issuance time of the token.
        Parameters:
        iat - What to set.

      • setIssuedAtEpoch

        public void setIssuedAtEpoch​(@NonNegative
                             long iat)
        Set the issuance time of the token using epoch seconds.
        Parameters:
        iat - What to set.

      • getIssuedAtEpoch

        @NonNegative
public long getIssuedAtEpoch()
        Get the issuance time of the token using epoch seconds.
        Returns:
        The issuance time of the token using epoch seconds.

      • getPrincipal

        @Nullable
@NotEmpty
public String getPrincipal()
        Get the principal who issued the token.
        Returns:
        The principal who issued the token.

      • setPrincipal

        public void setPrincipal​(@Nullable @NotEmpty
                         String prin)
        Set the principal who issued the token.
        Parameters:
        prin - What to set.

      • getAuthContext

        @Nullable
@NotEmpty
public String getAuthContext()
        Get the authentication context class reference value of the performed authentication.
        Returns:
        The authentication context class reference value of the performed authentication.

      • setAuthContext

        public void setAuthContext​(@Nullable @NotEmpty
                           String acr)
        Set the authentication context class reference value of the performed authentication.
        Parameters:
        acr - What to set.

      • getAuthTime

        @Nullable
public Instant getAuthTime()
        Get the authentication time of the performed authentication.
        Returns:
        The authentication time of the performed authentication.

      • setAuthTime

        public void setAuthTime​(@Nullable
                        Instant time)
        Set the authentication time of the performed authentication.
        Parameters:
        time - What to set.

      • getMetadata

        @Nullable
@NonnullElements
@NotLive
@Unmodifiable
public Map<String,​net.shibboleth.oidc.metadata.policy.MetadataPolicy> getMetadata()
        Get the allowed metadata values to be issued with the token.
        Returns:
        The allowed metadata values to be issued with the token.

      • setMetadata

        public void setMetadata​(@Nullable @NonnullElements
                        Map<String,​net.shibboleth.oidc.metadata.policy.MetadataPolicy> data)
        Set the allowed metadata values to be issued with the token.
        Parameters:
        data - What to set.

      • getRelyingPartyId

        @Nullable
@NotEmpty
public String getRelyingPartyId()
        Get the relying party identifier.
        Returns:
        The relying party identifier.

      • setRelyingPartyId

        public void setRelyingPartyId​(@Nullable @NotEmpty
                              String id)
        Set the relying party identifier.
        Parameters:
        id - id to set

      • getClientId

        @Nullable
@NotEmpty
public String getClientId()
        Get the client identifier.

        This is may or may not be the same as the relying party identifier, and if set is a signal to the registration flow to use this value rather than a generated one.

        Returns:
        client identifier.

      • setClientId

        public void setClientId​(@Nullable @NotEmpty
                        String id)
        Set the client identifier.
        Parameters:
        id - id to set

      • isReplacement

        public boolean isReplacement()
        Get the flag to signal replacement is allowed.
        Returns:
        true iff replacement is allowed

      • setReplacement

        public void setReplacement​(@Nullable
                           Boolean flag)
        Set the flag to signal replacement is allowed.
        Parameters:
        flag - flag to set