Package com.cloudbees.plugins.credentials.domains

Class HostnamePortSpecification

java.lang.Object

hudson.model.AbstractDescribableImpl<DomainSpecification>

com.cloudbees.plugins.credentials.domains.DomainSpecification

com.cloudbees.plugins.credentials.domains.HostnamePortSpecification

All Implemented Interfaces:

ExtensionPoint, Describable<DomainSpecification>, Serializable

public class HostnamePortSpecification
extends DomainSpecification

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

Since:

1.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HostnamePortSpecification.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
HostnamePortSpecification(String includes, String excludes)	Constructor for stapler.

Method Summary

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

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 Detail

HostnamePortSpecification

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

Constructor for stapler.

Parameters:

includes - Hostname and port combinations to match. A comma separated set of hostname:port with * wildcards supported. null signifies include everything.

excludes - Hostname and port combinations to explicitly not match. A comma separated set of hostname:port with * wildcards supported. null signifies exclude nothing.

Method Detail

getIncludes

@CheckForNull
public String getIncludes()

Returns the hostname and port combinations to match. A comma separated set of hostname:port with * wildcards supported. null signifies include everything.

Returns:

the hostname and port combinations to match.

getExcludes

@CheckForNull
public String getExcludes()

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

Returns:

the hostname and port combinations 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.