com.unboundid.scim.data

Class AuthenticationScheme

java.lang.Object

com.unboundid.scim.data.AuthenticationScheme

public class AuthenticationScheme
extends Object

This class represents the AuthenticationSchemes complex attribute in the Service Provider Config.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeValueResolver<AuthenticationScheme>	AUTHENTICATION_SCHEME_RESOLVER The AttributeValueResolver that resolves SCIM attribute values to/from AuthenticationScheme instances.

Constructor Summary

Constructors

Constructor and Description
AuthenticationScheme(String name, String description, String specUrl, String documentationUrl, String type, boolean primary) Create a value of the SCIM AuthenticationSchemes attribute.

Method Summary

Methods

Modifier and Type	Method and Description
static AuthenticationScheme	createBasic(boolean primary) Convenience method that creates a new AuthenticationScheme instances for HTTP BASIC.
static AuthenticationScheme	createOAuth2(boolean primary) Convenience method that creates a new AuthenticationScheme instances for OAuth 2.
boolean	equals(Object o)
String	getDescription() Retrieves the description of the Authentication Scheme.
String	getDocumentationUrl() Retrieves the HTTP addressable URL pointing to the Authentication Scheme's usage documentation.
String	getName() Retrieves the name of the Authentication Scheme.
String	getSpecUrl() Retrieves the HTTP addressable URL pointing to the Authentication Scheme's specification.
String	getType() Retrieves the type of Authentication Scheme.
int	hashCode()
boolean	isPrimary() Indicates whether this value is the primary value.
void	setDescription(String description) Sets the description of the Authentication Scheme.
void	setDocumentationUrl(String documentationUrl) Sets the HTTP addressable URL pointing to the Authentication Scheme's usage documentation.
void	setName(String name) Sets the name of the Authentication Scheme.
void	setPrimary(boolean primary) Specifies whether this value is the primary value.
void	setSpecUrl(String specUrl) Sets the HTTP addressable URL pointing to the Authentication Scheme's specification.
void	setType(String type) Sets the type of Authentication Scheme.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTHENTICATION_SCHEME_RESOLVER

public static final AttributeValueResolver<AuthenticationScheme> AUTHENTICATION_SCHEME_RESOLVER

The AttributeValueResolver that resolves SCIM attribute values to/from AuthenticationScheme instances.

Constructor Detail

AuthenticationScheme

public AuthenticationScheme(String name,
                    String description,
                    String specUrl,
                    String documentationUrl,
                    String type,
                    boolean primary)

Create a value of the SCIM AuthenticationSchemes attribute.

Parameters:

name - The name of the Authentication Scheme.

description - The description of the Authentication Scheme.

specUrl - A HTTP addressable URL pointing to the Authentication Scheme's specification.

documentationUrl - A HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

type - The type of Authentication Scheme.

primary - Specifies whether this value is the primary value.

Method Detail

getName

public String getName()

Retrieves the name of the Authentication Scheme.

Returns:

The name of the Authentication Scheme.

setName

public void setName(String name)

Sets the name of the Authentication Scheme.

Parameters:

name - The name of the Authentication Scheme.

getDescription

public String getDescription()

Retrieves the description of the Authentication Scheme.

Returns:

The description of the Authentication Scheme.

setDescription

public void setDescription(String description)

Sets the description of the Authentication Scheme.

Parameters:

description - The description of the Authentication Scheme.

getSpecUrl

public String getSpecUrl()

Retrieves the HTTP addressable URL pointing to the Authentication Scheme's specification.

Returns:

The the HTTP addressable URL pointing to the Authentication Scheme's specification, or null if there is none.

setSpecUrl

public void setSpecUrl(String specUrl)

Sets the HTTP addressable URL pointing to the Authentication Scheme's specification.

Parameters:

specUrl - The HTTP addressable URL pointing to the Authentication Scheme's specification.

getDocumentationUrl

public String getDocumentationUrl()

Retrieves the HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

Returns:

The HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

setDocumentationUrl

public void setDocumentationUrl(String documentationUrl)

Sets the HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

Parameters:

documentationUrl - The HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

isPrimary

public boolean isPrimary()

Indicates whether this value is the primary value.

Returns:

true if this value is the primary value or false otherwise.

setPrimary

public void setPrimary(boolean primary)

Specifies whether this value is the primary value.

Parameters:

primary - Whether this value is the primary value.

getType

public String getType()

Retrieves the type of Authentication Scheme.

Returns:

The type of Authentication Scheme.

setType

public void setType(String type)

Sets the type of Authentication Scheme.

Parameters:

type - The type of Authentication Scheme.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createBasic

public static AuthenticationScheme createBasic(boolean primary)

Convenience method that creates a new AuthenticationScheme instances for HTTP BASIC.

Parameters:

primary - Whether this authentication scheme is primary

Returns:

A new AuthenticationScheme instances for HTTP BASIC.

createOAuth2

public static AuthenticationScheme createOAuth2(boolean primary)

Convenience method that creates a new AuthenticationScheme instances for OAuth 2.

Parameters:

primary - Whether this authentication scheme is primary

Returns:

A new AuthenticationScheme instances for OAuth 2.