public interface

SignedObjectCallback

com.atlassian.bitbucket.scm.signed.SignedObjectCallback

Class Overview

Describes a callback for receiving information about signed objects.

Summary

Public Methods
void onEnd(SignedObjectsSummary summary)
Called after the signature information for the final requested object has been provided.
void onMissing(String objectId)
Called when no object was found in the repository for the requested objectId.
void onSigned(SignableObjectType type, String objectId, String signature, String signedContent)
Called when the requested object was found and contained a signature.
void onStart(SignedObjectsContext context)
Called before the signature information for the first requested object is provided.
void onUnsigned(SignableObjectType type, String objectId)
Called when the requested object was found, but was not signed.

Public Methods

public void onEnd (SignedObjectsSummary summary)

Called after the signature information for the final requested object has been provided.

Note: If there no objects were requested, this method may be called immediately after onStart(SignedObjectsContext) without any calls to any of the other callback methods.

Parameters
summary summarizes the request
Throws
IOException for implementations which perform I/O

public void onMissing (String objectId)

Called when no object was found in the repository for the requested objectId.

Parameters
objectId the requested object ID
Throws
IOException for implementations which perform I/O

public void onSigned (SignableObjectType type, String objectId, String signature, String signedContent)

Called when the requested object was found and contained a signature.

Parameters
type the type of object for which the signature and signed content is returned
objectId the requested object ID
signature the signature
signedContent the object content that was signed
Throws
IOException for implementations which perform I/O

public void onStart (SignedObjectsContext context)

Called before the signature information for the first requested object is provided.

Parameters
context provides details about the request for signature information is being streamed
Throws
IOException for implementations which perform I/O

public void onUnsigned (SignableObjectType type, String objectId)

Called when the requested object was found, but was not signed.

Parameters
type the type of object that was found if it's signable, otherwise null
objectId the requested object ID
Throws
IOException for implementations which perform I/O