Package com.ebasetech.xi.api
Interface GatewayAuthentication
- All Superinterfaces:
java.io.Serializable
public interface GatewayAuthentication
extends java.io.Serializable
The
GatewayAuthentication
is used to authenticate a Gateway Server request and using the JWE (JSON Web Encrypted) token and decode it to a JWT (JSON Web Token).
The JWE contains credentials relating to the user- Since:
- V5.7
-
Method Summary
Modifier and Type Method Description boolean
authorize(java.lang.String remoteServerName, java.lang.String jwe)
Decodes the JWE (JSON Web Encrypted) token and converts it into a JWT (JSON Web Token).java.lang.String
getGatewayRedirectURL()
Returns the originating URL of the Gateway Portal from the request.java.lang.String
getGatewayRequestToken()
Returns the JWE (JSON Web Encrypted) token embedded in the request.boolean
isGatewayRequest()
Returns true if the Http Request Gateway security parameter that contains the JWE (JSON Web Encrypted) token
-
Method Details
-
isGatewayRequest
boolean isGatewayRequest()Returns true if the Http Request Gateway security parameter that contains the JWE (JSON Web Encrypted) token -
getGatewayRequestToken
java.lang.String getGatewayRequestToken()Returns the JWE (JSON Web Encrypted) token embedded in the request.- Throws:
java.lang.RuntimeException
- if the JWE token is not found on the request- Since:
- V5.7
-
getGatewayRedirectURL
java.lang.String getGatewayRedirectURL()Returns the originating URL of the Gateway Portal from the request. This can be used to return the user back the Gateway Portal- Throws:
java.lang.RuntimeException
- if the Gateway Portal URL is not found on the request- Since:
- V5.7
-
authorize
boolean authorize(java.lang.String remoteServerName, java.lang.String jwe)Decodes the JWE (JSON Web Encrypted) token and converts it into a JWT (JSON Web Token). The JWT contains credentials relating the user.- Parameters:
remoteServerName
- of the remote server configuration that is configured on the Server Admin Appjwe
- is a base64 encoded encrypted JWE token- Returns:
- decoded JWT (JSON Web Token) that contains credentials relating the user
- Throws:
java.lang.RuntimeException
- if the remote server configuration is not found for the JWE token or if there is an error decoding the JWE- Since:
- V5.7
-