Package org.jenkinsci.plugins.github_branch_source.app_credentials

Class AccessInferredRepository

java.lang.Object

hudson.model.AbstractDescribableImpl<RepositoryAccessStrategy>

org.jenkinsci.plugins.github_branch_source.app_credentials.RepositoryAccessStrategy

org.jenkinsci.plugins.github_branch_source.app_credentials.AccessInferredRepository

All Implemented Interfaces:

Describable<RepositoryAccessStrategy>, Serializable

public class AccessInferredRepository
extends RepositoryAccessStrategy

This mode allows GitHubAppCredentials to generate an installation token whose owner and accessible repositories depend on the context in which the credential is used.

For example, when used in a multibranch project, the generated installation tokens will only allow access to the repository for the multibranch project itself. When used with an organization folder, each multibranch project will get an access token that is only valid for its own repository.

Note that some organization folder functionality (e.g. org scans) uses tokens that are not limited to a specific repository, but these tokens should never be accessible in the context of a Run.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessInferredRepository.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.github_branch_source.app_credentials.RepositoryAccessStrategy

RepositoryAccessStrategy.RepositoryAccessStrategyDescriptor

Constructor Summary

Constructors

Constructor	Description
AccessInferredRepository()

Method Summary

Modifier and Type	Method	Description
AccessibleRepositories	forContext(GitHubAppUsageContext context)	Get the AccessibleRepositories to use when generating installation access tokens for the inferred contextual owner and repository.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

AccessInferredRepository

@DataBoundConstructor
public AccessInferredRepository()

Method Details

forContext

public AccessibleRepositories forContext(GitHubAppUsageContext context)

Description copied from class: RepositoryAccessStrategy

Get the AccessibleRepositories to use when generating installation access tokens for the inferred contextual owner and repository.

Called when the credential is used in a context where an owner and repository can be inferred.

Specified by:

forContext in class RepositoryAccessStrategy

Returns:

null if the accessible repositories are unknown, or if no repositories are accessible in the specified context