org.jose4j.jws

Class JsonWebSignature

java.lang.Object

org.jose4j.jwx.JsonWebStructure

org.jose4j.jws.JsonWebSignature

public class JsonWebSignature
extends JsonWebStructure

Field Summary

Fields

Modifier and Type	Field and Description
static short	COMPACT_SERIALIZATION_PARTS

Fields inherited from class org.jose4j.jwx.JsonWebStructure

base64url, doKeyValidation, headers, rawCompactSerialization

Constructor Summary

Constructors

Constructor and Description
JsonWebSignature()

Method Summary

Methods

Modifier and Type	Method and Description
JsonWebSignatureAlgorithm	getAlgorithm()
JsonWebSignatureAlgorithm	getAlgorithmNoConstraintCheck()
String	getCompactSerialization()
String	getDetachedContentCompactSerialization() Produces the compact serialization with an empty/detached payload as described in Appendix F, Detached Content, of the JWS spec though providing library support rather than making the application do it all as described therein.
String	getEncodedPayload()
String	getEncodedSignature()
KeyPersuasion	getKeyPersuasion()
String	getKeyType()
String	getPayload()
String	getPayloadCharEncoding()
protected byte[]	getSignature()
String	getUnverifiedPayload()
protected void	onNewKey()
protected void	setCompactSerializationParts(String[] parts)
void	setEncodedPayload(String encodedPayload)
void	setPayload(String payload)
void	setPayloadCharEncoding(String payloadCharEncoding)
protected void	setSignature(byte[] signature)
void	sign()
boolean	verifySignature()

Methods inherited from class org.jose4j.jwx.JsonWebStructure

checkCrit, checkNotEmptyPart, fromCompactSerialization, getAlgorithmConstraints, getAlgorithmHeaderValue, getContentTypeHeaderValue, getEncodedHeader, getHeader, getHeader, getHeaders, getIntegrity, getKey, getKeyIdHeaderValue, getProviderCtx, getX509CertSha1ThumbprintHeaderValue, getX509CertSha256ThumbprintHeaderValue, isDoKeyValidation, setAlgorithmConstraints, setAlgorithmHeaderValue, setCompactSerialization, setContentTypeHeaderValue, setCriticalHeaderNames, setDoKeyValidation, setEncodedHeader, setHeader, setIntegrity, setKey, setKeyIdHeaderValue, setKnownCriticalHeaders, setProviderContext, setX509CertSha1ThumbprintHeaderValue, setX509CertSha1ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

COMPACT_SERIALIZATION_PARTS

public static final short COMPACT_SERIALIZATION_PARTS

See Also:

Constant Field Values

Constructor Detail

JsonWebSignature

public JsonWebSignature()

Method Detail

setPayload

public void setPayload(String payload)

Specified by:

setPayload in class JsonWebStructure

setCompactSerializationParts

protected void setCompactSerializationParts(String[] parts)
                                     throws JoseException

Specified by:

setCompactSerializationParts in class JsonWebStructure

Throws:

JoseException

getCompactSerialization

public String getCompactSerialization()
                               throws JoseException

Specified by:

getCompactSerialization in class JsonWebStructure

Throws:

JoseException

getDetachedContentCompactSerialization

public String getDetachedContentCompactSerialization()
                                              throws JoseException

Produces the compact serialization with an empty/detached payload as described in Appendix F, Detached Content, of the JWS spec though providing library support rather than making the application do it all as described therein.

Returns:

the encoded header + ".." + the encoded signature

Throws:

JoseException - if an error condition is encountered during the signing process

sign

public void sign()
          throws JoseException

Throws:

JoseException

onNewKey

protected void onNewKey()

Overrides:

onNewKey in class JsonWebStructure

verifySignature

public boolean verifySignature()
                        throws JoseException

Throws:

JoseException

getAlgorithm

public JsonWebSignatureAlgorithm getAlgorithm()
                                       throws InvalidAlgorithmException

Specified by:

getAlgorithm in class JsonWebStructure

Throws:

InvalidAlgorithmException

getAlgorithmNoConstraintCheck

public JsonWebSignatureAlgorithm getAlgorithmNoConstraintCheck()
                                                        throws InvalidAlgorithmException

Specified by:

getAlgorithmNoConstraintCheck in class JsonWebStructure

Throws:

InvalidAlgorithmException

getPayload

public String getPayload()
                  throws JoseException

Specified by:

getPayload in class JsonWebStructure

Throws:

JoseException

getUnverifiedPayload

public String getUnverifiedPayload()

getPayloadCharEncoding

public String getPayloadCharEncoding()

setPayloadCharEncoding

public void setPayloadCharEncoding(String payloadCharEncoding)

getKeyType

public String getKeyType()
                  throws InvalidAlgorithmException

Throws:

InvalidAlgorithmException

getKeyPersuasion

public KeyPersuasion getKeyPersuasion()
                               throws InvalidAlgorithmException

Throws:

InvalidAlgorithmException

setEncodedPayload

public void setEncodedPayload(String encodedPayload)

getEncodedPayload

public String getEncodedPayload()

getEncodedSignature

public String getEncodedSignature()

getSignature

protected byte[] getSignature()

setSignature

protected void setSignature(byte[] signature)