org.xdi.oxauth.model.jwt.JwtHeader クラス

org.xdi.oxauth.model.jwt.JwtHeader の継承関係図

org.xdi.oxauth.model.jwt.JwtHeader 連携図

公開メンバ関数
	JwtHeader ()
	JwtHeader (JSONObject jsonObject)
	JwtHeader (String base64JsonObject) throws InvalidJwtException
JwtHeader	setType (JwtType type)
SignatureAlgorithm	getAlgorithm ()
JwtHeader	setAlgorithm (SignatureAlgorithm algorithm)
JwtHeader	setAlgorithm (KeyEncryptionAlgorithm algorithm)
String	getKeyId ()
JwtHeader	setKeyId (String keyId)
void	setContentType (JwtType contentType)
void	setEncryptionMethod (BlockEncryptionAlgorithm encryptionMethod)
void	setEphemeralPublicKey (String ephemeralPublicKey)
void	setCompressionAlgorithm (String compressionAlgorithm)
void	setAgreementPartyUInfo (String agreementPartyUInfo)
void	setAgreementPartyVInfo (String agreementPartyVInfo)
void	setEncryptionPartyUInfo (String encryptionPartyUInfo)
void	setEncryptionPartyVInfo (String encryptionPartyVInfo)
Set< String >	keys ()
Object	getClaim (String key)
boolean	hasClaim (String key)
String	getClaimAsString (String key)
JSONObject	getClaimAsJSON (String key)
List< String >	getClaimAsStringList (String key)
Date	getClaimAsDate (String key)
Integer	getClaimAsInteger (String key)
Long	getClaimAsLong (String key)
Character	getClaimAsCharacter (String key)
void	setClaimObject (String key, Object value, boolean overrideValue)
void	setNullClaim (String key)
void	setClaim (String key, String value)
void	setClaim (String key, Date value)
void	setClaim (String key, Boolean value)
void	setClaim (String key, Integer value)
void	setClaim (String key, Long value)
void	setClaim (String key, Character value)
void	setClaim (String key, List values)
void	setClaim (String key, JwtSubClaimObject subClaimObject)
void	setClaim (String key, JSONObject values)
void	removeClaim (String key)
JSONObject	toJsonObject () throws InvalidJwtException
String	toBase64JsonObject () throws InvalidJwtException
String	toJsonString () throws InvalidJwtException
Map< String, List< String > >	toMap () throws InvalidJwtException
void	load (JSONObject jsonObject)
void	load (String base64JsonObject) throws InvalidJwtException

静的公開メンバ関数
static JwtHeader	instance ()

詳解

著者

Javier Rojas Blum

バージョン

June 15, 2016

構築子と解体子

JwtHeader() [1/3]

org.xdi.oxauth.model.jwt.JwtHeader.JwtHeader ( )

inline

                       {
        super();
    }

JwtHeader() [2/3]

org.xdi.oxauth.model.jwt.JwtHeader.JwtHeader ( JSONObject  jsonObject )

inline

                                            {
        super(jsonObject);
    }

JwtHeader() [3/3]

org.xdi.oxauth.model.jwt.JwtHeader.JwtHeader ( String  base64JsonObject ) throws InvalidJwtException

inline

                                                                         {
        super(base64JsonObject);
    }

関数詳解

getAlgorithm()

SignatureAlgorithm org.xdi.oxauth.model.jwt.JwtHeader.getAlgorithm ( )

inline

                                             {
        String alg = getClaimAsString(ALGORITHM);
        return SignatureAlgorithm.fromString(alg);
    }

getClaim()

Object org.xdi.oxauth.model.jwt.JwtClaimSet.getClaim ( String  key )

inlineinherited

                                       {
        return claims.get(key);
    }

getClaimAsCharacter()

Character org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsCharacter ( String  key )

inlineinherited

                                                     {
        Object claim = getClaim(key);

        if (claim != null) {
            if (claim instanceof Character) {
                return (Character) claim;
            } else {
                return null;
            }
        } else {
            return null;
        }
    }

getClaimAsDate()

Date org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsDate ( String  key )

inlineinherited

                                           {
        Object claim = getClaim(key);

        if (claim != null) {
            if (claim instanceof Date) {
                return (Date) claim;
            } else if (claim instanceof Integer) {
                final long c = (Integer) claim;
                final long date = c * 1000;
                return new Date(date);
            } else if (claim instanceof Long) {
                return new Date((Long) claim * 1000);
            } else if (claim instanceof Double) {
                final double c = (Double) claim;
                final BigDecimal bigDecimal = new BigDecimal(c);

                long claimLong = bigDecimal.longValue();
                claimLong = claimLong * 1000;

                return new Date(claimLong);
            } else {
                return null;
            }
        } else {
            return null;
        }
    }

getClaimAsInteger()

Integer org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsInteger ( String  key )

inlineinherited

                                                 {
        Object claim = getClaim(key);

        if (claim != null) {
            if (claim instanceof Integer) {
                return (Integer) claim;
            } else {
                return null;
            }
        } else {
            return null;
        }
    }

getClaimAsJSON()

JSONObject org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsJSON ( String  key )

inlineinherited

                                                 {
        String claim = getClaimAsString(key);

        try {
            if (claim != null) {
                JSONObject json = null;
                json = new JSONObject(claim);
                return json;
            }
        } catch (JSONException e) {
            e.printStackTrace();
        }

        return null;
    }

getClaimAsLong()

Long org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsLong ( String  key )

inlineinherited

                                           {
        Object claim = getClaim(key);

        if (claim != null) {
            if (claim instanceof Long) {
                return (Long) claim;
            } else {
                return null;
            }
        } else {
            return null;
        }
    }

getClaimAsString()

String org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsString ( String  key )

inlineinherited

                                               {
        Object claim = getClaim(key);

        if (claim != null) {
            return claim.toString();
        } else {
            return null;
        }
    }

getClaimAsStringList()

List<String> org.xdi.oxauth.model.jwt.JwtClaimSet.getClaimAsStringList ( String  key )

inlineinherited

                                                         {
        List<String> list = new ArrayList<String>();
        Object claims = getClaim(key);

        try {
            if (claims != null && claims instanceof JSONArray) {
                JSONArray jsonArray = (JSONArray) claims;
                for (int i = 0; i < jsonArray.length(); i++) {
                    list.add(jsonArray.getString(i));
                }
            } else {
                String claim = getClaimAsString(key);
                if (claim != null) {
                    list.add(claim);
                }
            }
        } catch (JSONException e) {
        }

        return list;
    }

getKeyId()

String org.xdi.oxauth.model.jwt.JwtHeader.getKeyId ( )

inline

                             {
        String keyId = getClaimAsString(KEY_ID);
        return keyId;
    }

hasClaim()

boolean org.xdi.oxauth.model.jwt.JwtClaimSet.hasClaim ( String  key )

inlineinherited

                                        {
        return getClaim(key) != null;
    }

instance()

static JwtHeader org.xdi.oxauth.model.jwt.JwtHeader.instance ( )

inlinestatic

                                       {
        return new JwtHeader();
    }

keys()

Set<String> org.xdi.oxauth.model.jwt.JwtClaimSet.keys ( )

inlineinherited

                              {
        return claims.keySet();
    }

load() [1/2]

void org.xdi.oxauth.model.jwt.JwtClaimSet.load ( JSONObject  jsonObject )

inlineinherited

                                            {
        claims.clear();

        for (Iterator<String> it = jsonObject.keys(); it.hasNext(); ) {
            String key = it.next();
            Object value = jsonObject.opt(key);

            claims.put(key, value);
        }
    }

load() [2/2]

void org.xdi.oxauth.model.jwt.JwtClaimSet.load ( String  base64JsonObject ) throws InvalidJwtException

inlineinherited

                                                                         {
        try {
            String jsonObjectString = new String(Base64Util.base64urldecode(base64JsonObject), Util.UTF8_STRING_ENCODING);
            load(new JSONObject(jsonObjectString));
        } catch (UnsupportedEncodingException e) {
            throw new InvalidJwtException(e);
        } catch (JSONException e) {
            throw new InvalidJwtException(e);
        } catch (Exception e) {
            throw new InvalidJwtException(e);
        }
    }

removeClaim()

void org.xdi.oxauth.model.jwt.JwtClaimSet.removeClaim ( String  key )

inlineinherited

                                        {
        claims.remove(key);
    }

setAgreementPartyUInfo()

void org.xdi.oxauth.model.jwt.JwtHeader.setAgreementPartyUInfo ( String  agreementPartyUInfo )

inline

The "apu" (agreement PartyUInfo) value for key agreement algorithms using it (such as "ECDH-ES"), represented as a base64url encoded string.

引数

agreementPartyUInfo

The Agreement PartyUInfo.

                                                                   {
        setClaim(AGREEMENT_PARTY_U_INFO, agreementPartyUInfo);
    }

setAgreementPartyVInfo()

void org.xdi.oxauth.model.jwt.JwtHeader.setAgreementPartyVInfo ( String  agreementPartyVInfo )

inline

The "apv" (agreement PartyVInfo) value for key agreement algorithms using it (such as "ECDH-ES"), represented as a base64url encoded string.

引数

agreementPartyVInfo

The Agreement PartyVInfo.

                                                                   {
        setClaim(AGREEMENT_PARTY_V_INFO, agreementPartyVInfo);
    }

setAlgorithm() [1/2]

JwtHeader org.xdi.oxauth.model.jwt.JwtHeader.setAlgorithm ( SignatureAlgorithm  algorithm )

inline

Identifies the cryptographic algorithm used to secure the JWS.

引数

algorithm

The cryptographic algorithm.

                                                                {
        if (algorithm == null) {
            setNullClaim(ALGORITHM);
        } else {
            setClaim(ALGORITHM, algorithm.toString());
        }
        return this;
    }

setAlgorithm() [2/2]

JwtHeader org.xdi.oxauth.model.jwt.JwtHeader.setAlgorithm ( KeyEncryptionAlgorithm  algorithm )

inline

Identifies the cryptographic algorithm used to encrypt the JWE.

引数

algorithm

The cryptographic algorithm.

                                                                    {
        if (algorithm == null) {
            setNullClaim(ALGORITHM);
        } else {
            setClaim(ALGORITHM, algorithm.toString());
        }
        return this;
    }

setClaim() [1/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, String  value  )

inlineinherited

                                                   {
        claims.put(key, value);
    }

setClaim() [2/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, Date  value  )

inlineinherited

                                                 {
        claims.put(key, value);
    }

setClaim() [3/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, Boolean  value  )

inlineinherited

                                                    {
        claims.put(key, value);
    }

setClaim() [4/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, Integer  value  )

inlineinherited

                                                    {
        claims.put(key, value);
    }

setClaim() [5/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, Long  value  )

inlineinherited

                                                 {
        claims.put(key, value);
    }

setClaim() [6/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, Character  value  )

inlineinherited

                                                      {
        claims.put(key, value);
    }

setClaim() [7/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, List  values  )

inlineinherited

                                                  {
        claims.put(key, values);
    }

setClaim() [8/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, JwtSubClaimObject  subClaimObject  )

inlineinherited

                                                                       {
        claims.put(key, subClaimObject);
    }

setClaim() [9/9]

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaim ( String  key, JSONObject  values  )

inlineinherited

                                                        {
        claims.put(key, values);
    }

setClaimObject()

void org.xdi.oxauth.model.jwt.JwtClaimSet.setClaimObject ( String  key, Object  value, boolean  overrideValue  )

inlineinherited

                                                                                {
        if (value == null) {
            setNullClaim(key);
        } else if (value instanceof String) {
            if (overrideValue) {
                setClaim(key, (String) value);
            } else {
                Object currentValue = getClaim(key);
                if (currentValue != null) {
                    setClaim(key, Lists.newArrayList(currentValue.toString(), (String) value));
                } else {
                    setClaim(key, (String) value);
                }
            }
        } else if (value instanceof Date) {
            setClaim(key, (Date) value);
        } else if (value instanceof Boolean) {
            setClaim(key, (Boolean) value);
        } else if (value instanceof Integer) {
            setClaim(key, (Integer) value);
        } else if (value instanceof Long) {
            setClaim(key, (Long) value);
        } else if (value instanceof Character) {
            setClaim(key, (Character) value);
        } else if (value instanceof List) {
            setClaim(key, (List) value);
        } else if (value instanceof JwtSubClaimObject) {
            setClaim(key, (JwtSubClaimObject) value);
        } else {
            throw new UnsupportedOperationException("Claim value is not supported, key: " + key + ", value :" + value);
        }
    }

setCompressionAlgorithm()

void org.xdi.oxauth.model.jwt.JwtHeader.setCompressionAlgorithm ( String  compressionAlgorithm )

inline

The "zip" (compression algorithm) applied to the Plaintext before encryption, if any. If present, the value of the "zip" header parameter MUST be the case sensitive string "DEF". Compression is performed with the DEFLATE algorithm.

引数

compressionAlgorithm

The compression algorithm.

                                                                     {
        setClaim(COMPRESSION_ALGORITHM, compressionAlgorithm);
    }

setContentType()

void org.xdi.oxauth.model.jwt.JwtHeader.setContentType ( JwtType  contentType )

inline

In a JWS it is used to declare the type of the secured content (the Payload). In a JWE it is used to declare the type of the encrypted content (the Plaintext).

引数

contentType

The content type.

                                                    {
        if (contentType == null) {
            setNullClaim(CONTENT_TYPE);
        } else {
            setClaim(CONTENT_TYPE, contentType.toString());
        }
    }

setEncryptionMethod()

void org.xdi.oxauth.model.jwt.JwtHeader.setEncryptionMethod ( BlockEncryptionAlgorithm  encryptionMethod )

inline

Identifies the block encryption algorithm used to encrypt the Plaintext to produce the Cipher Text.

引数

encryptionMethod

The JWE Encryption Method

                                                                               {
        if (encryptionMethod == null) {
            setNullClaim(ENCRYPTION_METHOD);
        } else {
            setClaim(ENCRYPTION_METHOD, encryptionMethod.toString());
        }
    }

setEncryptionPartyUInfo()

void org.xdi.oxauth.model.jwt.JwtHeader.setEncryptionPartyUInfo ( String  encryptionPartyUInfo )

inline

The "epu" (encryption PartyUInfo) value for plaintext encryption algorithms using it (such as "A128CBC+HS256"), represented as a base64url encoded string.

引数

encryptionPartyUInfo

The Encryption PartyUInfo.

                                                                     {
        setClaim(ENCRYPTION_PARTY_U_INFO, encryptionPartyUInfo);
    }

setEncryptionPartyVInfo()

void org.xdi.oxauth.model.jwt.JwtHeader.setEncryptionPartyVInfo ( String  encryptionPartyVInfo )

inline

The "epv" (encryption PartyVInfo) value for plaintext encryption algorithms using it (such as "A128CBC+HS256"), represented as a base64url encoded string.

引数

encryptionPartyVInfo

The Encryption PartyVInfo.

                                                                     {
        setClaim(ENCRYPTION_PARTY_V_INFO, encryptionPartyVInfo);
    }

setEphemeralPublicKey()

void org.xdi.oxauth.model.jwt.JwtHeader.setEphemeralPublicKey ( String  ephemeralPublicKey )

inline

Value created by the originator for the use in key agreement algorithms.

引数

ephemeralPublicKey

The Ephemeral Public Key.

                                                                 {
        setClaim(EPHEMERAL_PUBLIC_KEY, ephemeralPublicKey);
    }

setKeyId()

JwtHeader org.xdi.oxauth.model.jwt.JwtHeader.setKeyId ( String  keyId )

inline

Indicates which key was used to secure/encrypt the JWS/JWE.

引数

keyId

The key id.

                                            {
        setClaim(KEY_ID, keyId);
        return this;
    }

setNullClaim()

void org.xdi.oxauth.model.jwt.JwtClaimSet.setNullClaim ( String  key )

inlineinherited

                                         {
        claims.put(key, null);
    }

setType()

JwtHeader org.xdi.oxauth.model.jwt.JwtHeader.setType ( JwtType  type )

inline

Declares the type of this object.

引数

type	The type of this object.

                                           {
        if (type == null) {
            setNullClaim(TYPE);
        } else {
            setClaim(TYPE, type.toString());
        }
        return this;
    }

toBase64JsonObject()

String org.xdi.oxauth.model.jwt.JwtClaimSet.toBase64JsonObject ( ) throws InvalidJwtException

inlineinherited

                                                                  {
        try {
            String jsonObjectString = toJsonString();
            byte[] jsonObjectBytes = jsonObjectString.getBytes(Util.UTF8_STRING_ENCODING);
            return Base64Util.base64urlencode(jsonObjectBytes);
        } catch (UnsupportedEncodingException e) {
            return null;
        }
    }

toJsonObject()

JSONObject org.xdi.oxauth.model.jwt.JwtClaimSet.toJsonObject ( ) throws InvalidJwtException

inlineinherited

                                                                {
        JSONObject jsonObject = new JSONObject();

        try {
            for (Map.Entry<String, Object> claim : claims.entrySet()) {
                if (claim.getValue() instanceof Date) {
                    Date date = (Date) claim.getValue();
                    jsonObject.put(claim.getKey(), date.getTime() / 1000);
                } else if (claim.getValue() instanceof JwtSubClaimObject) {
                    JwtSubClaimObject subClaimObject = (JwtSubClaimObject) claim.getValue();
                    jsonObject.put(subClaimObject.getName(), subClaimObject.toJsonObject());
                } else if (claim.getValue() instanceof List) {
                    List claimObjectList = (List) claim.getValue();
                    JSONArray claimsJSONArray = new JSONArray();
                    for (Object claimObj : claimObjectList) {
                        claimsJSONArray.put(claimObj);
                    }
                    jsonObject.put(claim.getKey(), claimsJSONArray);
                } else {
                    jsonObject.put(claim.getKey(), claim.getValue());
                }
            }
        } catch (JSONException e) {
            throw new InvalidJwtException(e);
        } catch (Exception e) {
            throw new InvalidJwtException(e);
        }

        return jsonObject;
    }

toJsonString()

String org.xdi.oxauth.model.jwt.JwtClaimSet.toJsonString ( ) throws InvalidJwtException

inlineinherited

                                                            {
        JSONObject jsonObject = toJsonObject();
        String jsonObjectString = jsonObject.toString();
        jsonObjectString = jsonObjectString.replace("\\/", "/");

        return jsonObjectString;
    }

toMap()

Map<String, List<String> > org.xdi.oxauth.model.jwt.JwtClaimSet.toMap ( ) throws InvalidJwtException

inlineinherited

                                                                        {
        Map<String, List<String>> map = new HashMap<String, java.util.List<String>>();

        try {
            for (Map.Entry<String, Object> claim : claims.entrySet()) {
                String key = claim.getKey();
                Object value = claim.getValue();

                List<String> values = new ArrayList<String>();
                if (value instanceof JSONArray) {
                    JSONArray jsonArray = (JSONArray) value;
                    for (int i = 0; i < jsonArray.length(); i++) {
                        values.add(jsonArray.getString(i));
                    }
                } else if (value != null) {
                    values.add(value.toString());
                }

                map.put(key, values);
            }
        } catch (JSONException e) {
            throw new InvalidJwtException(e);
        }

        return map;
    }

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxAuth/Model/src/main/java/org/xdi/oxauth/model/jwt/JwtHeader.java