com.atlassian.bitbucket.scm.signed

Interface SignedObjectCallback

public interface SignedObjectCallback

Describes a callback for receiving information about signed objects.

Since:

5.1

See Also:

ScmExtendedCommandFactory.signedObjects(SignedObjectsParameters, SignedObjectCallback)

Method Summary

Modifier and Type	Method and Description
default 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.
default 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.

Method Detail

onEnd

default void onEnd(@Nonnull
                   SignedObjectsSummary summary)
            throws IOException

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

onMissing

void onMissing(@Nonnull
               String objectId)
        throws IOException

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

onSigned

void onSigned(@Nonnull
              SignableObjectType type,
              @Nonnull
              String objectId,
              @Nonnull
              String signature,
              @Nonnull
              String signedContent)
       throws IOException

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

onStart

default void onStart(@Nonnull
                     SignedObjectsContext context)
              throws IOException

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

onUnsigned

void onUnsigned(@Nullable
                SignableObjectType type,
                @Nonnull
                String objectId)
         throws IOException

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