org.pac4j.core.client

Class Clients

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.Clients

public class Clients
extends InitializableObject

This class is made to group multiple clients using a specific parameter to distinguish them, generally on one callback url.

The InitializableObject.init() method is used to initialize the callback urls of the clients from the callback url of the clients group if empty and a specific parameter added to define the client targeted. It is implicitly called by the "finders" methods and doesn't need to be called explicitly.

The findClient(WebContext), findClient(String) or findClient(Class) methods must be called to find the right client according to the input context or type. The findAllClients() method returns all the clients.

Since:

1.3.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLIENT_NAME_PARAMETER

Constructor Summary

Constructors

Constructor and Description
Clients()
Clients(Client... clients)
Clients(Client client)
Clients(List<Client> clients)
Clients(String callbackUrl, Client... clients)
Clients(String callbackUrl, Client client)
Clients(String callbackUrl, List<Client> clients)

Method Summary

Modifier and Type	Method and Description
void	addAuthorizationGenerator(AuthorizationGenerator authorizationGenerator)
List<Client>	findAllClients() Find all the clients.
<C extends Client> C	findClient(Class<C> clazz) Return the right client according to the specific class.
Client	findClient(String name) Return the right client according to the specific name.
Client	findClient(WebContext context) Return the right client according to the web context.
AjaxRequestResolver	getAjaxRequestResolver()
List<AuthorizationGenerator>	getAuthorizationGenerators()
String	getCallbackUrl()
String	getClientNameParameter()
List<Client>	getClients()
Client	getDefaultClient()
UrlResolver	getUrlResolver()
protected void	internalInit() Initialize all clients by computing callback urls if necessary.
void	setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)
void	setAuthorizationGenerator(AuthorizationGenerator authorizationGenerator)
void	setAuthorizationGenerators(AuthorizationGenerator... authorizationGenerators)
void	setAuthorizationGenerators(List<AuthorizationGenerator> authorizationGenerators)
void	setCallbackUrl(String callbackUrl)
void	setClientNameParameter(String clientNameParameter)
void	setClients(Client... clients)
void	setClients(List<Client> clients)
void	setDefaultClient(Client defaultClient) Set the default client (can be null).
void	setUrlResolver(UrlResolver urlResolver)
String	toString()
protected void	updateCallbackUrlOfIndirectClient(IndirectClient indirectClient) Sets a client's Callback URL, if not already set.

Methods inherited from class org.pac4j.core.util.InitializableObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_NAME_PARAMETER

public static final String DEFAULT_CLIENT_NAME_PARAMETER

See Also:

Constant Field Values

Constructor Detail

Clients

public Clients()

Clients

public Clients(String callbackUrl,
               List<Client> clients)

Clients

public Clients(String callbackUrl,
               Client... clients)

Clients

public Clients(String callbackUrl,
               Client client)

Clients

public Clients(List<Client> clients)

Clients

public Clients(Client... clients)

Clients

public Clients(Client client)

Method Detail

internalInit

protected void internalInit()

Initialize all clients by computing callback urls if necessary.

Specified by:

internalInit in class InitializableObject

updateCallbackUrlOfIndirectClient

protected void updateCallbackUrlOfIndirectClient(IndirectClient indirectClient)

Sets a client's Callback URL, if not already set. If requested, the "client_name" parameter will also be a part of the URL.

Parameters:

indirectClient - A client.

findClient

public Client findClient(WebContext context)

Return the right client according to the web context.

Parameters:

context - web context

Returns:

the right client

findClient

public Client findClient(String name)

Return the right client according to the specific name.

Parameters:

name - name of the client

Returns:

the right client

findClient

public <C extends Client> C findClient(Class<C> clazz)

Return the right client according to the specific class.

Type Parameters:

C - the kind of client

Parameters:

clazz - class of the client

Returns:

the right client

findAllClients

public List<Client> findAllClients()

Find all the clients.

Returns:

all the clients

getClientNameParameter

public String getClientNameParameter()

setClientNameParameter

public void setClientNameParameter(String clientNameParameter)

getCallbackUrl

public String getCallbackUrl()

setCallbackUrl

public void setCallbackUrl(String callbackUrl)

setClients

public void setClients(List<Client> clients)

setClients

public void setClients(Client... clients)

getClients

public List<Client> getClients()

setDefaultClient

public void setDefaultClient(Client defaultClient)

Set the default client (can be null). If not null, it must exist in the list of clients.

Parameters:

defaultClient - the default client to define

getDefaultClient

public Client getDefaultClient()

getAjaxRequestResolver

public AjaxRequestResolver getAjaxRequestResolver()

setAjaxRequestResolver

public void setAjaxRequestResolver(AjaxRequestResolver ajaxRequestResolver)

getUrlResolver

public UrlResolver getUrlResolver()

setUrlResolver

public void setUrlResolver(UrlResolver urlResolver)

getAuthorizationGenerators

public List<AuthorizationGenerator> getAuthorizationGenerators()

setAuthorizationGenerators

public void setAuthorizationGenerators(List<AuthorizationGenerator> authorizationGenerators)

setAuthorizationGenerators

public void setAuthorizationGenerators(AuthorizationGenerator... authorizationGenerators)

setAuthorizationGenerator

public void setAuthorizationGenerator(AuthorizationGenerator authorizationGenerator)

addAuthorizationGenerator

public void addAuthorizationGenerator(AuthorizationGenerator authorizationGenerator)

toString

public String toString()

Overrides:

toString in class Object