com.tencent.kona.sun.security.provider.certpath

Class BuildStep

java.lang.Object

com.tencent.kona.sun.security.provider.certpath.BuildStep

public class BuildStep
extends java.lang.Object

Describes one step of a certification path build, consisting of a Vertex state description, a certificate, a possible throwable, and a result code.

Since:

1.4

See Also:

Vertex

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACK result code associated with a certificate that was tried, but that represents an unsuccessful path, so the certificate has been backed out to allow backtracking to the next possible path.
static int	FAIL result code associated with a certificate that represents the end of the last possible path, where no path successfully reached the target.
static int	FOLLOW result code associated with a certificate that successfully continues the current path, but does not yet reach the target.
static int	POSSIBLE result code associated with a certificate that may continue a path from the current certificate.
static int	SUCCEED result code associated with a certificate that represents the end of a path that successfully reaches the target.

Constructor Summary

Constructors

Constructor and Description
BuildStep(Vertex vtx, int res) construct a BuildStep

Method Summary

Modifier and Type	Method and Description
java.lang.String	fullToString() return a string representation of this build step, including all possible detail of the vertex state, but not including the certificate contents.
java.security.cert.X509Certificate	getCertificate() return the certificate associated with this build step
java.lang.String	getIssuerName() return string form of issuer name from certificate associated with this build step
java.lang.String	getIssuerName(java.lang.String defaultName) return string form of issuer name from certificate associated with this build step, or a default name if no certificate associated with this build step, or if issuer name could not be obtained from the certificate.
int	getResult() return the result code associated with this build step.
java.lang.String	getSubjectName() return string form of subject name from certificate associated with this build step.
java.lang.String	getSubjectName(java.lang.String defaultName) return string form of subject name from certificate associated with this build step, or a default name if no certificate associated with this build step, or if subject name could not be obtained from the certificate.
java.lang.Throwable	getThrowable() return the exception associated with this build step.
Vertex	getVertex() return vertex description for this build step
java.lang.String	resultToString(int res) return a string representing the meaning of the result code associated with this build step.
java.lang.String	toString() return a string representation of this build step, showing minimal detail.
java.lang.String	verboseToString() return a string representation of this build step, showing all detail of the vertex state appropriate to the result of this build step, and the certificate contents.

Methods inherited from class java.lang.Object

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

Field Detail

POSSIBLE

public static final int POSSIBLE

result code associated with a certificate that may continue a path from the current certificate.

See Also:

Constant Field Values

BACK

public static final int BACK

result code associated with a certificate that was tried, but that represents an unsuccessful path, so the certificate has been backed out to allow backtracking to the next possible path.

See Also:

Constant Field Values

FOLLOW

public static final int FOLLOW

result code associated with a certificate that successfully continues the current path, but does not yet reach the target.

See Also:

Constant Field Values

FAIL

public static final int FAIL

result code associated with a certificate that represents the end of the last possible path, where no path successfully reached the target.

See Also:

Constant Field Values

SUCCEED

public static final int SUCCEED

result code associated with a certificate that represents the end of a path that successfully reaches the target.

See Also:

Constant Field Values

Constructor Detail

BuildStep

public BuildStep(Vertex vtx,
                 int res)

construct a BuildStep

Parameters:

vtx - description of the vertex at this step

res - result, where result is one of POSSIBLE, BACK, FOLLOW, FAIL, SUCCEED

Method Detail

getVertex

public Vertex getVertex()

return vertex description for this build step

Returns:

Vertex

getCertificate

public java.security.cert.X509Certificate getCertificate()

return the certificate associated with this build step

Returns:

X509Certificate

getIssuerName

public java.lang.String getIssuerName()

return string form of issuer name from certificate associated with this build step

Returns:

String form of issuer name or null, if no certificate.

getIssuerName

public java.lang.String getIssuerName(java.lang.String defaultName)

return string form of issuer name from certificate associated with this build step, or a default name if no certificate associated with this build step, or if issuer name could not be obtained from the certificate.

Parameters:

defaultName - name to use as default if unable to return an issuer name from the certificate, or if no certificate.

Returns:

String form of issuer name or defaultName, if no certificate or exception received while trying to extract issuer name from certificate.

getSubjectName

public java.lang.String getSubjectName()

return string form of subject name from certificate associated with this build step.

Returns:

String form of subject name or null, if no certificate.

getSubjectName

public java.lang.String getSubjectName(java.lang.String defaultName)

return string form of subject name from certificate associated with this build step, or a default name if no certificate associated with this build step, or if subject name could not be obtained from the certificate.

Parameters:

defaultName - name to use as default if unable to return a subject name from the certificate, or if no certificate.

Returns:

String form of subject name or defaultName, if no certificate or if an exception was received while attempting to extract the subject name from the certificate.

getThrowable

public java.lang.Throwable getThrowable()

return the exception associated with this build step.

Returns:

Throwable

getResult

public int getResult()

return the result code associated with this build step. The result codes are POSSIBLE, FOLLOW, BACK, FAIL, SUCCEED.

Returns:

int result code

resultToString

public java.lang.String resultToString(int res)

return a string representing the meaning of the result code associated with this build step.

Parameters:

res - result code

Returns:

String string representing meaning of the result code

toString

public java.lang.String toString()

return a string representation of this build step, showing minimal detail.

Overrides:

toString in class java.lang.Object

Returns:

String

verboseToString

public java.lang.String verboseToString()

return a string representation of this build step, showing all detail of the vertex state appropriate to the result of this build step, and the certificate contents.

Returns:

String

fullToString

public java.lang.String fullToString()

return a string representation of this build step, including all possible detail of the vertex state, but not including the certificate contents.

Returns:

String