com.authlete.common.dto

Class ClientExtension

java.lang.Object

com.authlete.common.dto.ClientExtension

All Implemented Interfaces:

Serializable

public class ClientExtension
extends Object
implements Serializable

Client extension.

There are some attributes that belong to a client application but should not be changed by the developer of the client application. Basically, this class holds such attributes.

For example, an authorization server may narrow the range of scopes (permissions) that a particular client application can request. In this case, it is meaningless if the developer of the client application can freely decide the set of requestable scopes. It is not the developer of the client application but the administrator of the authorization server that should be allowed to define the set of scopes that the client application can request.

Since:

1.39

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientExtension()

Method Summary

Modifier and Type	Method and Description
String[]	getRequestableScopes() Get the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).
boolean	isRequestableScopesEnabled() Check whether "Requestable Scopes per Client" is enabled or not.
ClientExtension	setRequestableScopes(Set<String> scopes) Set the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).
ClientExtension	setRequestableScopes(String[] scopes) Set the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).
ClientExtension	setRequestableScopesEnabled(boolean enabled) Enable or disable "Requestable Scopes per Client".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientExtension

public ClientExtension()

Method Detail

isRequestableScopesEnabled

public boolean isRequestableScopesEnabled()

Check whether "Requestable Scopes per Client" is enabled or not.

If this method returns true, a special set of scopes (permissions) is defined on the server side (the requestableScopes array represents the special set) and scopes which this client application can request are limited to the scopes listed in the set. In other words, this application cannot request scopes that are not included in the set. To be specific, this client application cannot list other scopes in the scope request parameter when it makes an authorization request. To be exact, other scopes can be listed but will be ignored by the authorization server.

On the other hand, if this method returns false, the valid set of scopes (permissions) that this client application can request is equal to the whole scope set defined by the authorization server.

Returns:

true if "Requestable Scopes per Client" is enabled for this client. Otherwise, false.

setRequestableScopesEnabled

public ClientExtension setRequestableScopesEnabled(boolean enabled)

Enable or disable "Requestable Scopes per Client".

See the description of isRequestableScopesEnabled() for details about "Requestable Scopes per Client".

Parameters:

enabled - true to enable "Requestable Scopes per Client". false to disable it.

Returns:

this object.

getRequestableScopes

public String[] getRequestableScopes()

Get the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).

See the description of isRequestableScopesEnabled() for details about "Requestable Scopes per Client".

Returns:

The set of scopes that this client application can request when "Requestable Scopes per Client" is enabled.

setRequestableScopes

public ClientExtension setRequestableScopes(String[] scopes)

Set the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).

See the description of isRequestableScopesEnabled() for details about "Requestable Scopes per Client".

Parameters:

scopes - A set of scopes.

Returns:

this object.

setRequestableScopes

public ClientExtension setRequestableScopes(Set<String> scopes)

Set the set of scopes that this client application can request when "Requestable Scopes per Client" is enabled (= when isRequestableScopesEnabled() returns true).

See the description of isRequestableScopesEnabled() for details about "Requestable Scopes per Client".

Parameters:

scopes - A set of scopes.

Returns:

this object.

Since:

1.41