jenkins.scm.api.trait

Class SCMHeadAuthority<S extends SCMSourceRequest,H extends SCMHeadMixin,R extends SCMRevision>

java.lang.Object

hudson.model.AbstractDescribableImpl<SCMHeadAuthority<?,?,?>>

jenkins.scm.api.trait.SCMHeadAuthority<S,H,R>

Type Parameters:

S - the type of SCMSourceRequest.

H - the specialization of SCMHeadMixin that this authority provides trust information for.

R - the specialization of SCMRevision that this authority provides trust information for.

All Implemented Interfaces:

Describable<SCMHeadAuthority<?,?,?>>

public abstract class SCMHeadAuthority<S extends SCMSourceRequest,H extends SCMHeadMixin,R extends SCMRevision>
extends AbstractDescribableImpl<SCMHeadAuthority<?,?,?>>

Abstraction to allow pluggable definitions of trust for SCMHead and SCMRevision instances in the context of a specific SCMSourceRequest.

Note: there can be multiple authorities for the same types of head / revision active in the context of any one request. The ultimate trust state is determined by a logical OR operation, in other words if any one authority says that the head / revision is trusted then the head / revision is trusted.

Since:

3.4.0

Constructor Summary

Constructors

Constructor and Description
SCMHeadAuthority()

Method Summary

Modifier and Type	Method and Description
static List<SCMHeadAuthorityDescriptor>	_for(Class<? extends SCMSourceRequest> requestClass, Class<? extends SCMHeadMixin> headClass, Class<? extends SCMRevision> revisionClass, Class<? extends SCMHeadOrigin>... origins) Returns the subset of SCMHeadAuthorityDescriptor instances applicable to the supplied criteria.
static DescriptorExtensionList<SCMHeadAuthority<?,?,?>,SCMHeadAuthorityDescriptor>	all() Returns a list of all SCMHeadAuthorityDescriptor instances.
protected abstract boolean	checkTrusted(S request, H head) SPI: checks if the supplied SCMHead is trusted in the context of the supplied SCMSourceRequest.
protected boolean	checkTrusted(S request, R revision) SPI: checks if the supplied SCMRevision is trusted in the context of the supplied SCMSourceRequest.
SCMHeadAuthorityDescriptor	getDescriptor()
boolean	isApplicableTo(SCMHead head) Checks if this authority is relevant to the supplied SCMHead.
boolean	isApplicableTo(SCMRevision revision) Checks if this authority is relevant to the supplied SCMRevision.
boolean	isApplicableTo(SCMSourceRequest request) Checks if this authority is relevant to the supplied SCMSourceRequest.
boolean	isTrusted(SCMSourceRequest request, SCMHead head) Checks if the supplied SCMHead is trusted in the context of the specified SCMSourceRequest.
boolean	isTrusted(SCMSourceRequest request, SCMRevision revision) Checks if the supplied SCMRevision is trusted in the context of the specified SCMSourceRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadAuthority

public SCMHeadAuthority()

Method Detail

isApplicableTo

public final boolean isApplicableTo(@NonNull
                                    SCMHead head)

Checks if this authority is relevant to the supplied SCMHead.

Parameters:

head - the supplied SCMHead.

Returns:

true if and only if this authority can provide trust information for the supplied head.

isApplicableTo

public final boolean isApplicableTo(@NonNull
                                    SCMRevision revision)

Checks if this authority is relevant to the supplied SCMRevision.

Parameters:

revision - the supplied SCMRevision.

Returns:

true if and only if this authority can provide trust information for the supplied revision.

isApplicableTo

public final boolean isApplicableTo(@NonNull
                                    SCMSourceRequest request)

Checks if this authority is relevant to the supplied SCMSourceRequest.

Parameters:

request - the supplied SCMSourceRequest.

Returns:

true if and only if this authority can provide trust information for the supplied request.

isTrusted

public final boolean isTrusted(@NonNull
                               SCMSourceRequest request,
                               @NonNull
                               SCMHead head)
                        throws IOException,
                               InterruptedException

Checks if the supplied SCMHead is trusted in the context of the specified SCMSourceRequest.

Parameters:

request - the SCMSourceRequest.

head - the SCMHead.

Returns:

true if the supplied head is trusted.

Throws:

IOException - if there was an I/O error trying to establish the trust status.

InterruptedException - if interrupted while trying to establing the trust status.

isTrusted

public final boolean isTrusted(@NonNull
                               SCMSourceRequest request,
                               @CheckForNull
                               SCMRevision revision)
                        throws IOException,
                               InterruptedException

Checks if the supplied SCMRevision is trusted in the context of the specified SCMSourceRequest.

Parameters:

request - the SCMSourceRequest.

revision - the SCMRevision.

Returns:

true if the supplied revision is trusted.

Throws:

IOException - if there was an I/O error trying to establish the trust status.

InterruptedException - if interrupted while trying to establing the trust status.

checkTrusted

protected abstract boolean checkTrusted(@NonNull
                                        S request,
                                        @NonNull
                                        H head)
                                 throws IOException,
                                        InterruptedException

SPI: checks if the supplied SCMHead is trusted in the context of the supplied SCMSourceRequest.

Parameters:

request - the SCMSourceRequest.

head - the SCMHead.

Returns:

true if trusted.

Throws:

IOException - if there was an I/O error trying to establish the trust status.

InterruptedException - if interrupted while trying to establing the trust status.

checkTrusted

@OverrideMustInvoke
protected boolean checkTrusted(@NonNull
                                                   S request,
                                                   @NonNull
                                                   R revision)
                                            throws IOException,
                                                   InterruptedException

SPI: checks if the supplied SCMRevision is trusted in the context of the supplied SCMSourceRequest. Default implementation just calls checkTrusted(SCMSourceRequest, SCMHeadMixin) with SCMRevision.getHead().

Parameters:

request - the SCMSourceRequest.

revision - the SCMRevision.

Returns:

true if trusted.

Throws:

IOException - if there was an I/O error trying to establish the trust status.

InterruptedException - if interrupted while trying to establing the trust status.

getDescriptor

public SCMHeadAuthorityDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<SCMHeadAuthority<?,?,?>>

Overrides:

getDescriptor in class AbstractDescribableImpl<SCMHeadAuthority<?,?,?>>

all

public static DescriptorExtensionList<SCMHeadAuthority<?,?,?>,SCMHeadAuthorityDescriptor> all()

Returns a list of all SCMHeadAuthorityDescriptor instances.

Returns:

a list of all SCMHeadAuthorityDescriptor instances.

_for

public static List<SCMHeadAuthorityDescriptor> _for(@CheckForNull
                                                    Class<? extends SCMSourceRequest> requestClass,
                                                    @CheckForNull
                                                    Class<? extends SCMHeadMixin> headClass,
                                                    @CheckForNull
                                                    Class<? extends SCMRevision> revisionClass,
                                                    Class<? extends SCMHeadOrigin>... origins)

Returns the subset of SCMHeadAuthorityDescriptor instances applicable to the supplied criteria.

Parameters:

requestClass - the SCMSourceRequest class (or null to match any).

headClass - the SCMHeadMixin class (or null to match any).

revisionClass - the SCMRevision class (or null to match any).

origins - the SCMHeadOrigin instances.

Returns:

the list of matching SCMHeadAuthorityDescriptor instances.