com.cloudbees.plugins.credentials.domains

Class Domain

java.lang.Object

com.cloudbees.plugins.credentials.domains.Domain

All Implemented Interfaces:

Serializable

public class Domain
extends Object
implements Serializable

A domain, within which credentials are common. For example a company may have a single sign-on domain where a bunch of web applications, source control systems, issue trackers, etc all share the same username/password backing database.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Domain(String name, String description, List<DomainSpecification> specifications)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Returns the description of this domain.
String	getName() Returns the name of the domain.
List<DomainSpecification>	getSpecifications() Returns the DomainSpecifications for this Domain.
String	getUrl() Return the store relative URL of this domain.
static Domain	global() Returns the special "global" domain.
int	hashCode()
boolean	isGlobal() Tests if this is the global() domain.
Domain	resolve() Resolve the correct domain instance.
boolean	test(DomainRequirement... requirements) Returns true if and only if the supplied DomainRequirements are a match for this Domain.
boolean	test(List<DomainRequirement> requirements) Returns true if and only if the supplied DomainRequirements are a match for this Domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

Domain

@DataBoundConstructor
public Domain(String name,
                                    String description,
                                    List<DomainSpecification> specifications)

Method Detail

global

@NonNull
public static Domain global()

Returns the special "global" domain.

Returns:

the special "global" domain.

resolve

public Domain resolve()

Resolve the correct domain instance.

Returns:

the correct domain instance (i.e. replaces the global domain with global().

getDescription

@CheckForNull
public String getDescription()

Returns the description of this domain.

Returns:

the description of this domain.

getSpecifications

@NonNull
public List<DomainSpecification> getSpecifications()

Returns the DomainSpecifications for this Domain.

Returns:

the DomainSpecifications for this Domain.

getName

@CheckForNull
public String getName()

Returns the name of the domain.

Returns:

the name of the domain.

getUrl

public String getUrl()

Return the store relative URL of this domain.

Returns:

the store relative URL of this domain.

isGlobal

public boolean isGlobal()

Tests if this is the global() domain.

Returns:

true if and only if this is the global() domain.

Since:

2.0

test

public boolean test(DomainRequirement... requirements)

Returns true if and only if the supplied DomainRequirements are a match for this Domain.

Parameters:

requirements - the DomainRequirements to test.

Returns:

true if and only if the supplied DomainRequirements are a match for this Domain.

test

public boolean test(@NonNull
                    List<DomainRequirement> requirements)

Returns true if and only if the supplied DomainRequirements are a match for this Domain.

Parameters:

requirements - the DomainRequirements to test.

Returns:

true if and only if the supplied DomainRequirements are a match for this Domain.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object