org.wso2.micro.gateway.jwt.generator

Class AbstractMGWJWTGenerator

java.lang.Object

org.wso2.micro.gateway.jwt.generator.AbstractMGWJWTGenerator

Direct Known Subclasses:

MGWJWTGeneratorImpl

public abstract class AbstractMGWJWTGenerator
extends Object

Abstract class for generate JWT for backend claims.

Constructor Summary

Constructors

Constructor and Description
AbstractMGWJWTGenerator(String dialectURI, String signatureAlgorithm, String keyStorePath, String keyStorePassword, String certificateAlias, String privateKeyAlias, int jwtExpiryTime, String[] restrictedClaims, boolean cacheEnabled, int cacheExpiry, String tokenIssuer, String[] tokenAudience)

Method Summary

Modifier and Type	Method and Description
String	addCertToHeader() Used to add "ballerina"the certificate from the keystore to the header.
net.minidev.json.JSONArray	arrayToJSONArray(Object[] objectArray) Method to convert Java array to JSONArray.
String	buildBody(Map<String,Object> jwtInfo) Used to build the body with claims.
String	buildHeader() Used to build the JWT header.
String	encode(byte[] stringToBeEncoded) Used for base64 encoding.
String	generateToken(Map<String,Object> jwtInfo) Used to generate the JWT token.
Map<String,Object>	getApiDetails()
int	getCacheExpiry()
String	getCertificateAlias()
List<String>	getDefaultRestrictedClaims()
String	getDialectURI()
int	getJwtExpiryTime()
String	getKeyStorePassword()
String	getKeyStorePath()
String	getPrivateKeyAlias()
ArrayList<String>	getRestrictedClaims()
String	getSignatureAlgorithm()
String[]	getTokenAudience()
String	getTokenIssuer()
long	getTTL() Used to get the expiration time of the token.
String	hexify(byte[] bytes) Helper method to hexify a byte array.
boolean	isCacheEnabled()
abstract Map<String,Object>	populateCustomClaims(Map<String,Object> jwtInfo, ArrayList<String> restrictedClaims)
abstract Map<String,Object>	populateStandardClaims(Map<String,Object> jwtInfo)
void	setApiDetails(Map<String,Object> apiDetails)
void	setCacheEnabled(boolean cacheEnabled)
void	setCacheExpiry(int cacheExpiry)
void	setCertificateAlias(String certificateAlias)
void	setDefaultRestrictedClaims(List<String> defaultRestrictedClaims)
void	setDialectURI(String dialectURI)
void	setJwtExpiryTime(int jwtExpiryTime)
void	setKeyStorePassword(String keyStorePassword)
void	setKeyStorePath(String keyStorePath)
void	setPrivateKeyAlias(String privateKeyAlias)
void	setRestrictedClaims(ArrayList<String> restrictedClaims)
void	setSignatureAlgorithm(String signatureAlgorithm)
void	setTokenAudience(String[] tokenAudience)
void	setTokenIssuer(String tokenIssuer)
byte[]	signJWT(String assertion) Used to sign the JWT using the keystore.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMGWJWTGenerator

public AbstractMGWJWTGenerator(String dialectURI,
                               String signatureAlgorithm,
                               String keyStorePath,
                               String keyStorePassword,
                               String certificateAlias,
                               String privateKeyAlias,
                               int jwtExpiryTime,
                               String[] restrictedClaims,
                               boolean cacheEnabled,
                               int cacheExpiry,
                               String tokenIssuer,
                               String[] tokenAudience)

Method Detail

getPrivateKeyAlias

public String getPrivateKeyAlias()

setPrivateKeyAlias

public void setPrivateKeyAlias(String privateKeyAlias)

getDefaultRestrictedClaims

public List<String> getDefaultRestrictedClaims()

setDefaultRestrictedClaims

public void setDefaultRestrictedClaims(List<String> defaultRestrictedClaims)

getCertificateAlias

public String getCertificateAlias()

setCertificateAlias

public void setCertificateAlias(String certificateAlias)

getApiDetails

public Map<String,Object> getApiDetails()

setApiDetails

public void setApiDetails(Map<String,Object> apiDetails)

getTokenAudience

public String[] getTokenAudience()

setTokenAudience

public void setTokenAudience(String[] tokenAudience)

getTokenIssuer

public String getTokenIssuer()

setTokenIssuer

public void setTokenIssuer(String tokenIssuer)

isCacheEnabled

public boolean isCacheEnabled()

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

getCacheExpiry

public int getCacheExpiry()

setCacheExpiry

public void setCacheExpiry(int cacheExpiry)

getRestrictedClaims

public ArrayList<String> getRestrictedClaims()

setRestrictedClaims

public void setRestrictedClaims(ArrayList<String> restrictedClaims)

getKeyStorePath

public String getKeyStorePath()

setKeyStorePath

public void setKeyStorePath(String keyStorePath)

getKeyStorePassword

public String getKeyStorePassword()

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

getDialectURI

public String getDialectURI()

setDialectURI

public void setDialectURI(String dialectURI)

getSignatureAlgorithm

public String getSignatureAlgorithm()

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

getJwtExpiryTime

public int getJwtExpiryTime()

setJwtExpiryTime

public void setJwtExpiryTime(int jwtExpiryTime)

generateToken

public String generateToken(Map<String,Object> jwtInfo)
                     throws Exception

Used to generate the JWT token.

Throws:

Exception

buildHeader

public String buildHeader()
                   throws Exception

Used to build the JWT header.

Throws:

Exception

signJWT

public byte[] signJWT(String assertion)
               throws Exception

Used to sign the JWT using the keystore.

Throws:

Exception

getTTL

public long getTTL()

Used to get the expiration time of the token.

addCertToHeader

public String addCertToHeader()
                       throws Exception

Used to add "ballerina"the certificate from the keystore to the header.

Throws:

Exception

buildBody

public String buildBody(Map<String,Object> jwtInfo)

Used to build the body with claims.

encode

public String encode(byte[] stringToBeEncoded)

Used for base64 encoding.

hexify

public String hexify(byte[] bytes)

Helper method to hexify a byte array.

arrayToJSONArray

public net.minidev.json.JSONArray arrayToJSONArray(Object[] objectArray)

Method to convert Java array to JSONArray.

populateStandardClaims

public abstract Map<String,Object> populateStandardClaims(Map<String,Object> jwtInfo)

populateCustomClaims

public abstract Map<String,Object> populateCustomClaims(Map<String,Object> jwtInfo,
                                                        ArrayList<String> restrictedClaims)