Package sonia.scm.repository

Class Repository

java.lang.Object

sonia.scm.BasicPropertiesAware

sonia.scm.repository.Repository

All Implemented Interfaces:

com.github.sdorra.ssp.PermissionObject, Serializable, Cloneable, AuditLogEntity, LastModifiedAware, ModelObject, PropertiesAware, RepositoryCoordinates, RepositoryPermissionHolder, TypedObject, Validateable

@IndexedType(namespaceScoped=true)
@StaticPermissions(value="repository",
                   permissions={"read","modify","delete","rename","healthCheck","pull","push","permissionRead","permissionWrite","archive","export"},
                   custom=true,
                   customGlobal=true,
                   guards=)
public class Repository
extends BasicPropertiesAware
implements ModelObject, com.github.sdorra.ssp.PermissionObject, RepositoryCoordinates, RepositoryPermissionHolder, AuditLogEntity

Source code repository.

See Also:

• Serialized Form

Field Summary

Fields inherited from class sonia.scm.BasicPropertiesAware

properties

Constructor Summary

Constructors

Constructor	Description
Repository()	This constructor is used by JAXB.
Repository(String id, String type, String namespace, String name)	Constructs a new Repository.
Repository(String id, String type, String namespace, String name, String contact, String description, RepositoryPermission... permissions)	Constructs a new Repository.

Method Summary

Modifier and Type	Method	Description
void	addPermission(RepositoryPermission newPermission)	Adds a single permission to the current set of permissions for this object.
Repository	clone()
void	copyProperties(Repository repository)	Copies all properties of the Repository to the given one.
boolean	equals(Object obj)
String	getContact()	Returns a contact email address of a person who is responsible for the Repository.
Long	getCreationDate()	Returns a timestamp of the creation date of the Repository.
String	getDescription()	Returns a short description of the Repository.
String	getEntityName()	Get the entity name which is used for the audit log
List<HealthCheckFailure>	getHealthCheckFailures()	Returns a List of HealthCheckFailures.
String	getId()	Returns the unique id of the model object
Long	getLastModified()	Returns a timestamp of the last modified date.
String	getName()	Returns the name of the repository.
String	getNamespace()	Returns the namespace of the repository.
NamespaceAndName	getNamespaceAndName()
Collection<RepositoryPermission>	getPermissions()	Returns a collection of all permissions for this object.
String	getType()	Returns the type (hg, git, svn ...) of the Repository.
int	hashCode()
boolean	isArchived()	Returns true, when the repository is marked as "archived".
boolean	isHealthy()	Returns true if the repository is healthy.
boolean	isValid()	Returns true if the Repository is valid.
boolean	removePermission(RepositoryPermission permission)	Removes a single permission from the current set of permissions for this object.
void	setArchived(boolean archived)	Set this to true to mark the repository as "archived".
void	setContact(String contact)
void	setCreationDate(Long creationDate)
void	setDescription(String description)
void	setHealthCheckFailures(List<HealthCheckFailure> healthCheckFailures)
void	setId(String id)
void	setLastModified(Long lastModified)
void	setName(String name)
void	setNamespace(String namespace)
void	setPermissions(Collection<RepositoryPermission> permissions)	Sets and therefore overwrites the permissions for this object.
void	setType(String type)
String	toFullString()
String	toString()

Methods inherited from class sonia.scm.BasicPropertiesAware

getProperties, getProperty, removeProperty, setProperties, setProperty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface sonia.scm.repository.RepositoryPermissionHolder

findGroupPermission, findUserPermission

Constructor Details

Repository

public Repository()

This constructor is used by JAXB.

Repository

public Repository(String id,
 String type,
 String namespace,
 String name)

Constructs a new Repository.

Parameters:

id - id of the Repository

type - type of the Repository

name - name of the Repository

Repository

public Repository(String id,
 String type,
 String namespace,
 String name,
 String contact,
 String description,
 RepositoryPermission... permissions)

Constructs a new Repository.

Parameters:

id - id of the Repository

type - type of the Repository

name - name of the Repository

namespace - namespace of the Repository

contact - email address of a person who is responsible for this repository.

description - a short description of the repository

permissions - permissions for specific users and groups.

Method Details

getContact

public String getContact()

Returns a contact email address of a person who is responsible for the Repository.

Returns:

contact email address

getCreationDate

public Long getCreationDate()

Returns a timestamp of the creation date of the Repository.

Specified by:

getCreationDate in interface ModelObject

getDescription

public String getDescription()

Returns a short description of the Repository.

getHealthCheckFailures

public List<HealthCheckFailure> getHealthCheckFailures()

Returns a List of HealthCheckFailures. The List is empty if the repository is healthy.

Returns:

List of HealthCheckFailures

Since:

1.36

getId

public String getId()

Description copied from interface: ModelObject

Returns the unique id of the model object

Specified by:

getId in interface ModelObject

Specified by:

getId in interface com.github.sdorra.ssp.PermissionObject

Specified by:

getId in interface RepositoryCoordinates

getLastModified

public Long getLastModified()

Description copied from interface: LastModifiedAware

Returns a timestamp of the last modified date.

Specified by:

getLastModified in interface LastModifiedAware

getName

public String getName()

Description copied from interface: RepositoryCoordinates

Returns the name of the repository.

Specified by:

getName in interface RepositoryCoordinates

getNamespace

public String getNamespace()

Description copied from interface: RepositoryCoordinates

Returns the namespace of the repository.

Specified by:

getNamespace in interface RepositoryCoordinates

getNamespaceAndName

public NamespaceAndName getNamespaceAndName()

getPermissions

public Collection<RepositoryPermission> getPermissions()

Description copied from interface: RepositoryPermissionHolder

Returns a collection of all permissions for this object.

Specified by:

getPermissions in interface RepositoryPermissionHolder

getType

public String getType()

Returns the type (hg, git, svn ...) of the Repository.

Specified by:

getType in interface TypedObject

isArchived

public boolean isArchived()

Returns true, when the repository is marked as "archived". An archived repository cannot be modified.

Since:

2.11.0

isHealthy

public boolean isHealthy()

Returns true if the repository is healthy.

Returns:

true if the repository is healthy

Since:

1.36

isValid

public boolean isValid()

Returns true if the Repository is valid.

• The namespace is valid
• The name is valid
• The type is not empty
• The contact is empty or contains a valid email address

Specified by:

isValid in interface Validateable

Returns:

true if the Repository is valid

setContact

public void setContact(String contact)

setCreationDate

public void setCreationDate(Long creationDate)

Specified by:

setCreationDate in interface ModelObject

setDescription

public void setDescription(String description)

setId

public void setId(String id)

setLastModified

public void setLastModified(Long lastModified)

Specified by:

setLastModified in interface ModelObject

setNamespace

public void setNamespace(String namespace)

setName

public void setName(String name)

setPermissions

public void setPermissions(Collection<RepositoryPermission> permissions)

Description copied from interface: RepositoryPermissionHolder

Sets and therefore overwrites the permissions for this object.

Specified by:

setPermissions in interface RepositoryPermissionHolder

Parameters:

permissions - The new permissions for this object.

addPermission

public void addPermission(RepositoryPermission newPermission)

Description copied from interface: RepositoryPermissionHolder

Adds a single permission to the current set of permissions for this object.

Specified by:

addPermission in interface RepositoryPermissionHolder

Parameters:

newPermission - The new permission that will be added to the existing permissions.

removePermission

public boolean removePermission(RepositoryPermission permission)

Description copied from interface: RepositoryPermissionHolder

Removes a single permission from the current set of permissions for this object.

Specified by:

removePermission in interface RepositoryPermissionHolder

Parameters:

permission - The permission that should be removed from the existing permissions.

Returns:

true, if the given permission was part of the permissions for this object, false otherwise.

setType

public void setType(String type)

setArchived

public void setArchived(boolean archived)

Set this to true to mark the repository as "archived". An archived repository cannot be modified.

Since:

2.11.0

setHealthCheckFailures

public void setHealthCheckFailures(List<HealthCheckFailure> healthCheckFailures)

clone

public Repository clone()

Overrides:

clone in class Object

copyProperties

public void copyProperties(Repository repository)

Copies all properties of the Repository to the given one.

Parameters:

repository - the target Repository

equals

public boolean equals(Object obj)

Overrides:

equals in class BasicPropertiesAware

hashCode

public int hashCode()

Overrides:

hashCode in class BasicPropertiesAware

toString

public String toString()

Overrides:

toString in class Object

toFullString

public String toFullString()

getEntityName

public String getEntityName()

Get the entity name which is used for the audit log

Specified by:

getEntityName in interface AuditLogEntity

Since:

2.43.0