Bouncy Castle PKIX, CMS, EAC, TSP, PKCS, OCSP, CMP, and CRMF APIs 1.77 · org.bouncycastle.cms.KeyAgreeRecipientId

Modifier and Type	Field and Description
private X509CertificateHolderSelector	baseSelector

Access	Constructor and Description
private	KeyAgreeRecipientId(X509CertificateHolderSelector baseSelector)
public	KeyAgreeRecipientId(byte[] a subjectKeyId subjectKeyId) Construct a key agree recipient ID with the value of a public key's subjectKeyId.
public	KeyAgreeRecipientId(X500Name the issuer of the recipient's associated certificate. issuer, BigInteger the serial number of the recipient's associated certificate. serialNumber) Construct a key agree recipient ID based on the issuer and serial number of the recipient's associated certificate.
public	KeyAgreeRecipientId(X500Name issuer, BigInteger serialNumber, byte[] subjectKeyId)

Modifier and Type	Method and Description
public Object	clone() Implements abstract org.bouncycastle.cms.RecipientId.clone. Implements org.bouncycastle.util.Selector.clone. Creates and returns a copy of this object.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public X500Name	getIssuer()
public BigInteger	getSerialNumber()
public byte[]	getSubjectKeyIdentifier()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	match(Object the object to be matched. obj) Implements org.bouncycastle.util.Selector.match. Match the passed in object, returning true if it would be selected by this selector, false otherwise.

Field Detail

baseSelector	back to summary
private X509CertificateHolderSelector baseSelector

Constructor Detail

KeyAgreeRecipientId	back to summary
private KeyAgreeRecipientId(X509CertificateHolderSelector baseSelector)

KeyAgreeRecipientId	back to summary
public KeyAgreeRecipientId(byte[] subjectKeyId) Construct a key agree recipient ID with the value of a public key's subjectKeyId. Parameters subjectKeyId:byte[] a subjectKeyId

KeyAgreeRecipientId

back to summary

public KeyAgreeRecipientId(byte[] subjectKeyId)

Construct a key agree recipient ID with the value of a public key's subjectKeyId.

Parameters

subjectKeyId:byte[]: a subjectKeyId

KeyAgreeRecipientId	back to summary
public KeyAgreeRecipientId(X500Name issuer, BigInteger serialNumber) Construct a key agree recipient ID based on the issuer and serial number of the recipient's associated certificate. Parameters issuer:X500Name the issuer of the recipient's associated certificate. serialNumber:BigInteger the serial number of the recipient's associated certificate.

KeyAgreeRecipientId

back to summary

public KeyAgreeRecipientId(X500Name issuer, BigInteger serialNumber)

Construct a key agree recipient ID based on the issuer and serial number of the recipient's associated certificate.

Parameters

issuer:X500Name: the issuer of the recipient's associated certificate.
serialNumber:BigInteger: the serial number of the recipient's associated certificate.

KeyAgreeRecipientId	back to summary
public KeyAgreeRecipientId(X500Name issuer, BigInteger serialNumber, byte[] subjectKeyId)

Method Detail

clone back to summary

clone	back to summary
public Object clone() Implements abstract org.bouncycastle.cms.RecipientId.clone. Implements org.bouncycastle.util.Selector.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance.

public Object clone()

Implements abstract org.bouncycastle.cms.RecipientId.clone.

Implements org.bouncycastle.util.Selector.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object: a clone of this instance.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getIssuer	back to summary
public X500Name getIssuer()

getSerialNumber	back to summary
public BigInteger getSerialNumber()

getSubjectKeyIdentifier	back to summary
public byte[] getSubjectKeyIdentifier()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object.

match	back to summary
public boolean match(Object obj) Implements org.bouncycastle.util.Selector.match. Doc from org.bouncycastle.util.Selector.match. Match the passed in object, returning true if it would be selected by this selector, false otherwise. Parameters obj:Object the object to be matched. Returns:boolean true if the object is a match for this selector, false otherwise.

match

back to summary

public boolean match(Object obj)

Implements org.bouncycastle.util.Selector.match.

Doc from org.bouncycastle.util.Selector.match.

Match the passed in object, returning true if it would be selected by this selector, false otherwise.

Parameters

obj:Object: the object to be matched.

Returns:boolean

true if the object is a match for this selector, false otherwise.

public Class KeyAgreeRecipientId

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail