Package com.jalios.rest.client.authentication

Class JWTAuthentication

java.lang.Object

com.jalios.rest.client.authentication.JWTAuthentication

All Implemented Interfaces:

Authentication

public class JWTAuthentication
extends java.lang.Object
implements Authentication

JCMS Open API Authentication using authentication key. Many such authentication may been added to a single ClientSession.

Constructor Summary

Constructors

Constructor	Description
JWTAuthentication(java.lang.String token)	OpenAPI Authentication based on JWT authentication for a single url.
JWTAuthentication(java.lang.String privateKeyPath, java.lang.String keyPassword, java.lang.String channelName, java.lang.String login)	OpenAPI Authentication based on JWT authentication for a single url.
JWTAuthentication(java.lang.String privateKeyPath, java.lang.String keyPassword, org.jose4j.jwt.JwtClaims claims)	OpenAPI Authentication based on JWT authentication for a single url.
JWTAuthentication(java.security.PrivateKey key, java.lang.String channelName, java.lang.String login)	OpenAPI Authentication based on JWT authentication for a single url.
JWTAuthentication(java.security.PrivateKey key, org.jose4j.jwt.JwtClaims claims)	OpenAPI Authentication based on JWT authentication for a single url.

Method Summary

Modifier and Type	Method	Description
void	addAuthentication(org.restlet.data.Request request)
int	getAcceptableDrift()
java.lang.String	getChannelName()
org.jose4j.jwt.JwtClaims	getClaims()
int	getDuration()
java.lang.String	getIpMask()
java.security.PrivateKey	getKey()
java.lang.String	getLogin()
java.lang.String	getToken()
boolean	isDeprecated()	A authentication may be available for a few time.
boolean	isUseSpecificJplatformClaims()
void	setAcceptableDrift(int acceptableDrift)
void	setChannelName(java.lang.String channelName)
void	setClaims(org.jose4j.jwt.JwtClaims claims)
void	setDuration(int duration)
void	setIpMask(java.lang.String ipMask)
void	setKey(java.security.PrivateKey key)
void	setLogin(java.lang.String login)
void	setToken(java.lang.String token)
void	setUseSpecificJplatformClaims(boolean useSpecificJplatformClaims)
org.restlet.data.Response	updateAuthenticationResult(ClientSession session, org.restlet.data.Request request, org.restlet.data.Response response)

Methods inherited from class java.lang.Object

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

Constructor Detail

JWTAuthentication

public JWTAuthentication(java.lang.String privateKeyPath,
                         java.lang.String keyPassword,
                         java.lang.String channelName,
                         java.lang.String login)

OpenAPI Authentication based on JWT authentication for a single url.

Parameters:

privateKeyPath - the file path of the private key

keyPassword - the password of the private key

channelName - the remote channel name

login - the remote login, used to build authentication

JWTAuthentication

public JWTAuthentication(java.security.PrivateKey key,
                         org.jose4j.jwt.JwtClaims claims)

OpenAPI Authentication based on JWT authentication for a single url.

Parameters:

key - the PrivateKey

claims - JwtClaims the claims to be used for token generation

JWTAuthentication

public JWTAuthentication(java.lang.String privateKeyPath,
                         java.lang.String keyPassword,
                         org.jose4j.jwt.JwtClaims claims)

OpenAPI Authentication based on JWT authentication for a single url.

Parameters:

privateKeyPath - the file path of the private key

keyPassword - the password of the private key

claims - JwtClaims the claims to be used for token generation

JWTAuthentication

public JWTAuthentication(java.security.PrivateKey key,
                         java.lang.String channelName,
                         java.lang.String login)

OpenAPI Authentication based on JWT authentication for a single url.

Parameters:

key - the PrivateKey

channelName - the remote channel name

login - the remote login, used to build authentication

JWTAuthentication

public JWTAuthentication(java.lang.String token)

OpenAPI Authentication based on JWT authentication for a single url.

Parameters:

token - the JWT token (built outside)

Method Detail

addAuthentication

public void addAuthentication(org.restlet.data.Request request)

Specified by:

addAuthentication in interface Authentication

updateAuthenticationResult

public org.restlet.data.Response updateAuthenticationResult(ClientSession session,
                                                            org.restlet.data.Request request,
                                                            org.restlet.data.Response response)

Specified by:

updateAuthenticationResult in interface Authentication

isDeprecated

public boolean isDeprecated()

Description copied from interface: Authentication

A authentication may be available for a few time. If it is no longer, it is Deprecated

Specified by:

isDeprecated in interface Authentication

Returns:

true if the method is no longer available

getKey

public java.security.PrivateKey getKey()

setKey

public void setKey(java.security.PrivateKey key)

getChannelName

public java.lang.String getChannelName()

setChannelName

public void setChannelName(java.lang.String channelName)

getLogin

public java.lang.String getLogin()

setLogin

public void setLogin(java.lang.String login)

getAcceptableDrift

public int getAcceptableDrift()

setAcceptableDrift

public void setAcceptableDrift(int acceptableDrift)

getDuration

public int getDuration()

setDuration

public void setDuration(int duration)

getClaims

public org.jose4j.jwt.JwtClaims getClaims()

setClaims

public void setClaims(org.jose4j.jwt.JwtClaims claims)

getToken

public java.lang.String getToken()

setToken

public void setToken(java.lang.String token)

getIpMask

public java.lang.String getIpMask()

setIpMask

public void setIpMask(java.lang.String ipMask)

isUseSpecificJplatformClaims

public boolean isUseSpecificJplatformClaims()

setUseSpecificJplatformClaims

public void setUseSpecificJplatformClaims(boolean useSpecificJplatformClaims)