Package com.cloudbees.plugins.credentials.domains

Class HostnameSpecification

java.lang.Object

hudson.model.AbstractDescribableImpl<DomainSpecification>

com.cloudbees.plugins.credentials.domains.DomainSpecification

com.cloudbees.plugins.credentials.domains.HostnameSpecification

All Implemented Interfaces:

ExtensionPoint, Describable<DomainSpecification>, Serializable

public class HostnameSpecification
extends DomainSpecification

A DomainSpecification that matches HostnameRequirement where the hostname is on an includes list but not on an excludes list. The includes and excludes lists are comma separated hostname with * wildcards supported.

Since:

1.5

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HostnameSpecification.DescriptorImpl	Our Descriptor.

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.domains.DomainSpecification

DomainSpecification.Result

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
HostnameSpecification(String includes, String excludes)	Constructor for stapler.

Method Summary

Modifier and Type	Method	Description
String	getExcludes()	Returns the hostnames to explicitly not match.
String	getIncludes()	Returns the hostnames to match.
DomainSpecification.Result	test(DomainRequirement requirement)	Tests the scope against this specification.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

HostnameSpecification

@DataBoundConstructor
public HostnameSpecification(@CheckForNull
 String includes,
 @CheckForNull
 String excludes)

Constructor for stapler.

Parameters:

includes - Hostnames to match. A comma separated set of hostname with * wildcards supported. null signifies include everything.

excludes - Hostnames to explicitly not match. A comma separated set of hostname with * wildcards supported. null signifies exclude nothing.

Method Details

getIncludes

@CheckForNull
public String getIncludes()

Returns the hostnames to match. A comma separated set of hostname with * wildcards supported. null signifies include everything.

Returns:

the hostnames to match.

getExcludes

@CheckForNull
public String getExcludes()

Returns the hostnames to explicitly not match. A comma separated set of hostname with * wildcards supported. null signifies include everything.

Returns:

the hostnames to explicitly not match.

test

@NonNull
public DomainSpecification.Result test(@NonNull
 DomainRequirement requirement)

Tests the scope against this specification.

Specified by:

test in class DomainSpecification

Parameters:

requirement - the scope to test.

Returns:

the result of the test.