com.akamai.edgeauth

Class EdgeAuth

java.lang.Object

com.akamai.edgeauth.EdgeAuth

public class EdgeAuth
extends java.lang.Object

This is for returning authorization token string. You can build an instance using EdgeAuthBuilder and this can throw EdgeAuthException.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	NOW Current time when using startTime

Constructor Summary

Constructors

Constructor and Description
EdgeAuth(java.lang.String tokenType, java.lang.String tokenName, java.lang.String key, java.lang.String algorithm, java.lang.String salt, java.lang.String ip, java.lang.String payload, java.lang.String sessionId, java.lang.Long startTime, java.lang.Long endTime, java.lang.Long windowSeconds, char fieldDelimiter, char aclDelimiter, boolean escapeEarly, boolean verbose)

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateACLToken(java.lang.String acl) Call generateToken
java.lang.String	generateACLToken(java.lang.String[] acl) Call generateToken
java.lang.String	generateURLToken(java.lang.String url) Call generateToken
char	getAclDelimiter()
java.lang.String	getAlgorithm()
long	getEndTime()
char	getFieldDelimiter()
java.lang.String	getIp()
java.lang.String	getKey()
java.lang.String	getPayload()
java.lang.String	getSalt()
java.lang.String	getSessionId()
long	getStartTime()
java.lang.String	getTokenName()
java.lang.String	getTokenType()
long	getwindowSeconds()
boolean	isEscapeEarly()
boolean	isVerbose()
static java.lang.String	join(char delimiter, java.lang.String[] lists) Makes a string array to joined a string with delimiter.
void	setAclDelimiter(char aclDelimiter)
void	setAlgorithm(java.lang.String algorithm)
void	setEndTime(java.lang.Long endTime)
void	setEscapeEarly(boolean escapeEarly)
void	setFieldDelimiter(char fieldDelimiter)
void	setIp(java.lang.String ip)
void	setKey(java.lang.String key)
void	setPayload(java.lang.String payload)
void	setSalt(java.lang.String salt)
void	setSessionId(java.lang.String sessionId)
void	setStartTime(java.lang.Long startTime)
void	setTokenName(java.lang.String tokenName)
void	setTokenType(java.lang.String tokenType)
void	setVerbose(boolean verbose)
void	setWindowSeconds(java.lang.Long windowSeconds)

Methods inherited from class java.lang.Object

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

Field Detail

NOW

public static final java.lang.Long NOW

Current time when using startTime

Constructor Detail

EdgeAuth

public EdgeAuth(java.lang.String tokenType,
                java.lang.String tokenName,
                java.lang.String key,
                java.lang.String algorithm,
                java.lang.String salt,
                java.lang.String ip,
                java.lang.String payload,
                java.lang.String sessionId,
                java.lang.Long startTime,
                java.lang.Long endTime,
                java.lang.Long windowSeconds,
                char fieldDelimiter,
                char aclDelimiter,
                boolean escapeEarly,
                boolean verbose)
         throws EdgeAuthException

Throws:

EdgeAuthException

Method Detail

join

public static java.lang.String join(char delimiter,
                                    java.lang.String[] lists)
                             throws EdgeAuthException

Makes a string array to joined a string with delimiter.

Parameters:

delimiter - ACL_DELIMITER

lists - ACL(Access Control List) string array

Returns:

joined string with delimiter

Throws:

EdgeAuthException - EdgeAuthException

generateURLToken

public java.lang.String generateURLToken(java.lang.String url)
                                  throws EdgeAuthException

Call generateToken

Parameters:

url - a single path

Returns:

authorization token string

Throws:

EdgeAuthException - EdgeAuthException

generateACLToken

public java.lang.String generateACLToken(java.lang.String acl)
                                  throws EdgeAuthException

Call generateToken

Parameters:

acl - access control list (String)

Returns:

authorization token string

Throws:

EdgeAuthException - EdgeAuthException

generateACLToken

public java.lang.String generateACLToken(java.lang.String[] acl)
                                  throws EdgeAuthException

Call generateToken

Parameters:

acl - access control list (String[])

Returns:

authorization token string

Throws:

EdgeAuthException - EdgeAuthException

setTokenType

public void setTokenType(java.lang.String tokenType)

Parameters:

tokenType - tokenType

setTokenName

public void setTokenName(java.lang.String tokenName)
                  throws EdgeAuthException

Parameters:

tokenName - tokenName

Throws:

EdgeAuthException - EdgeAuthException

setKey

public void setKey(java.lang.String key)
            throws EdgeAuthException

Parameters:

key - key

Throws:

EdgeAuthException - EdgeAuthException

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)
                  throws EdgeAuthException

Parameters:

algorithm - algorithm

Throws:

EdgeAuthException - EdgeAuthException

setSalt

public void setSalt(java.lang.String salt)

Parameters:

salt - salt

setIp

public void setIp(java.lang.String ip)

Parameters:

ip - ip

setPayload

public void setPayload(java.lang.String payload)

Parameters:

payload - payload

setSessionId

public void setSessionId(java.lang.String sessionId)

Parameters:

sessionId - sessionId

setStartTime

public void setStartTime(java.lang.Long startTime)

Parameters:

startTime - startTime

setEndTime

public void setEndTime(java.lang.Long endTime)

Parameters:

endTime - endTime

setWindowSeconds

public void setWindowSeconds(java.lang.Long windowSeconds)

Parameters:

windowSeconds - windowSeconds

setAclDelimiter

public void setAclDelimiter(char aclDelimiter)

Parameters:

aclDelimiter - aclDelimiter

setFieldDelimiter

public void setFieldDelimiter(char fieldDelimiter)

Parameters:

fieldDelimiter - fieldDelimiter

setEscapeEarly

public void setEscapeEarly(boolean escapeEarly)

Parameters:

escapeEarly - escapeEarly

setVerbose

public void setVerbose(boolean verbose)

Parameters:

verbose - verbose

getTokenType

public java.lang.String getTokenType()

Returns:

tokenType

getTokenName

public java.lang.String getTokenName()

Returns:

tokenName

getKey

public java.lang.String getKey()

Returns:

key

getAlgorithm

public java.lang.String getAlgorithm()

Returns:

algorithm

getSalt

public java.lang.String getSalt()

Returns:

salt

getIp

public java.lang.String getIp()

Returns:

ip

getPayload

public java.lang.String getPayload()

Returns:

payload

getSessionId

public java.lang.String getSessionId()

Returns:

sessionId

getStartTime

public long getStartTime()

Returns:

startTime

getEndTime

public long getEndTime()

Returns:

endTime

getwindowSeconds

public long getwindowSeconds()

Returns:

windowSeconds

getFieldDelimiter

public char getFieldDelimiter()

Returns:

fieldDelimiter

getAclDelimiter

public char getAclDelimiter()

Returns:

aclDelimiter

isEscapeEarly

public boolean isEscapeEarly()

Returns:

escapeEarly

isVerbose

public boolean isVerbose()

Returns:

verbose