org.gbif.api.model.registry

Class Installation

java.lang.Object

org.gbif.api.model.registry.Installation

All Implemented Interfaces:

Serializable, Commentable, Contactable, Endpointable, Identifiable, LenientEquals<Installation>, MachineTaggable, NetworkEntity, Taggable

public class Installation
extends Object
implements NetworkEntity, Contactable, Endpointable, MachineTaggable, Taggable, Commentable, Identifiable, LenientEquals<Installation>

A technical installation which can serve datasets. Note: An Installation may be marked as disabled, meaning that some process has identified it is out of action. For the GBIF crawling infrastructure, this means it will not be "metasynced" nor will any dataset associated be eligible for crawling.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Installation()

Method Summary

Modifier and Type	Method and Description
void	addEndpoint(Endpoint endpoint)
void	addMachineTag(MachineTag machineTag)
boolean	equals(Object o)
List<Comment>	getComments()
List<Contact>	getContacts()
@Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) Date	getCreated()
String	getCreatedBy()
Date	getDeleted()
String	getDescription()
List<Endpoint>	getEndpoints()
List<Identifier>	getIdentifiers()
@Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) UUID	getKey()
List<MachineTag>	getMachineTags()
@Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) Date	getModified()
String	getModifiedBy()
@NotNull UUID	getOrganizationKey()
String	getPassword() Get the installation password.
List<Tag>	getTags()
String	getTitle()
@NotNull InstallationType	getType()
int	hashCode()
boolean	isDisabled()
boolean	lenientEquals(Installation other) Does not include the nested properties, or server controlled values (key, createdBy etc) or the password, for security reasons.
void	setComments(List<Comment> comments)
void	setContacts(List<Contact> contacts)
void	setCreated(Date created)
void	setCreatedBy(String createdBy)
void	setDeleted(Date deleted)
void	setDescription(String description)
void	setDisabled(boolean disabled)
void	setEndpoints(List<Endpoint> endpoints)
void	setIdentifiers(List<Identifier> identifiers)
void	setKey(UUID key)
void	setMachineTags(List<MachineTag> machineTags)
void	setModified(Date modified)
void	setModifiedBy(String modifiedBy)
void	setOrganizationKey(UUID organizationKey)
void	setPassword(String password)
void	setTags(List<Tag> tags)
void	setTitle(String title)
void	setType(InstallationType type)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Installation

public Installation()

Method Detail

getKey

@Null(groups=PrePersist.class)
 @NotNull(groups=PostPersist.class)
public @Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) UUID getKey()

Specified by:

getKey in interface NetworkEntity

setKey

public void setKey(UUID key)

Specified by:

setKey in interface NetworkEntity

getTitle

public String getTitle()

Specified by:

getTitle in interface NetworkEntity

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface NetworkEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface NetworkEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface NetworkEntity

getCreated

@Null(groups=PrePersist.class)
 @NotNull(groups=PostPersist.class)
public @Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) Date getCreated()

Specified by:

getCreated in interface NetworkEntity

setCreated

public void setCreated(Date created)

Specified by:

setCreated in interface NetworkEntity

getModified

@Null(groups=PrePersist.class)
 @NotNull(groups=PostPersist.class)
public @Null(groups=PrePersist.class) @NotNull(groups=PostPersist.class) Date getModified()

Specified by:

getModified in interface NetworkEntity

setModified

public void setModified(Date modified)

Specified by:

setModified in interface NetworkEntity

getDeleted

public Date getDeleted()

Specified by:

getDeleted in interface NetworkEntity

setDeleted

public void setDeleted(Date deleted)

Specified by:

setDeleted in interface NetworkEntity

getOrganizationKey

@NotNull
public @NotNull UUID getOrganizationKey()

setOrganizationKey

public void setOrganizationKey(UUID organizationKey)

getPassword

@Nullable
public String getPassword()

Get the installation password. This method is to be ignored on serialization, so that the password is not revealed in the web service response.

Returns:

organization password

setPassword

public void setPassword(String password)

getType

@NotNull
public @NotNull InstallationType getType()

setType

public void setType(InstallationType type)

getCreatedBy

public String getCreatedBy()

Specified by:

getCreatedBy in interface NetworkEntity

setCreatedBy

public void setCreatedBy(String createdBy)

Specified by:

setCreatedBy in interface NetworkEntity

getModifiedBy

public String getModifiedBy()

Specified by:

getModifiedBy in interface NetworkEntity

setModifiedBy

public void setModifiedBy(String modifiedBy)

Specified by:

setModifiedBy in interface NetworkEntity

getContacts

public List<Contact> getContacts()

Specified by:

getContacts in interface Contactable

setContacts

public void setContacts(List<Contact> contacts)

Specified by:

setContacts in interface Contactable

getEndpoints

public List<Endpoint> getEndpoints()

Specified by:

getEndpoints in interface Endpointable

setEndpoints

public void setEndpoints(List<Endpoint> endpoints)

Specified by:

setEndpoints in interface Endpointable

addEndpoint

public void addEndpoint(Endpoint endpoint)

Specified by:

addEndpoint in interface Endpointable

getMachineTags

public List<MachineTag> getMachineTags()

Specified by:

getMachineTags in interface MachineTaggable

setMachineTags

public void setMachineTags(List<MachineTag> machineTags)

Specified by:

setMachineTags in interface MachineTaggable

addMachineTag

public void addMachineTag(MachineTag machineTag)

Specified by:

addMachineTag in interface MachineTaggable

getTags

public List<Tag> getTags()

Specified by:

getTags in interface Taggable

setTags

public void setTags(List<Tag> tags)

Specified by:

setTags in interface Taggable

getIdentifiers

public List<Identifier> getIdentifiers()

Specified by:

getIdentifiers in interface Identifiable

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

Specified by:

setIdentifiers in interface Identifiable

getComments

public List<Comment> getComments()

Specified by:

getComments in interface Commentable

setComments

public void setComments(List<Comment> comments)

Specified by:

setComments in interface Commentable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

lenientEquals

public boolean lenientEquals(Installation other)

Does not include the nested properties, or server controlled values (key, createdBy etc) or the password, for security reasons.

Specified by:

lenientEquals in interface LenientEquals<Installation>

Parameters:

other - To compare against

Returns:

true if...