Package com.linecorp.centraldogma.server.metadata

Class MetadataService

java.lang.Object

com.linecorp.centraldogma.server.metadata.MetadataService

public class MetadataService
extends Object

A service class for metadata management.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_JSON	A path of metadata file.
static final String	TOKEN_JSON	A path of token list file.

Constructor Summary

Constructors

Constructor	Description
MetadataService(ProjectManager projectManager, CommandExecutor executor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Revision>	activateToken(Author author, String appId)	Activates the Token of the specified appId.
CompletableFuture<Revision>	addMember(Author author, String projectName, User member, ProjectRole projectRole)	Adds the specified member to the ProjectMetadata of the specified projectName with the specified projectRole.
CompletableFuture<Revision>	addRepo(Author author, String projectName, String repoName)	Adds a RepositoryMetadata of the specified repoName to the specified projectName with a default RepositoryRole.
CompletableFuture<Revision>	addRepo(Author author, String projectName, String repoName, ProjectRoles projectRoles)	Adds a RepositoryMetadata of the specified repoName to the specified projectName with the specified ProjectRoles.
CompletableFuture<Revision>	addToken(Author author, String projectName, Token token, ProjectRole role)	Adds the specified Token to the specified projectName.
CompletableFuture<Revision>	addToken(Author author, String projectName, String appId, ProjectRole role)	Adds a Token of the specified appId to the specified projectName.
CompletableFuture<Revision>	addTokenRepositoryRole(Author author, String projectName, String repoName, String appId, RepositoryRole role)	Adds the RepositoryRole for the Token of the specified appId to the specified repoName in the specified projectName.
CompletableFuture<Revision>	addUserRepositoryRole(Author author, String projectName, String repoName, User member, RepositoryRole role)	Adds the RepositoryRole for the specified member to the specified repoName in the specified projectName.
CompletableFuture<Revision>	createToken(Author author, String appId)	Creates a new user-level Token with the specified appId.
CompletableFuture<Revision>	createToken(Author author, String appId, boolean isSystemAdmin)	Creates a new Token with the specified appId, isSystemAdmin and an auto-generated secret.
CompletableFuture<Revision>	createToken(Author author, String appId, String secret)	Creates a new user-level Token with the specified appId and secret.
CompletableFuture<Revision>	createToken(Author author, String appId, String secret, boolean isSystemAdmin)	Creates a new Token with the specified appId, secret and isSystemAdmin.
CompletableFuture<Revision>	deactivateToken(Author author, String appId)	Deactivates the Token of the specified appId.
CompletableFuture<Revision>	destroyToken(Author author, String appId)	Removes the Token of the specified appId completely from the system.
CompletableFuture<ProjectRole>	findProjectRole(String projectName, User user)	Finds a ProjectRole of the specified User in the specified projectName.
CompletableFuture<RepositoryRole>	findRepositoryRole(String projectName, String repoName, User user)	Finds RepositoryRole of the specified User or UserWithToken from the specified repoName in the specified projectName.
CompletableFuture<RepositoryRole>	findRepositoryRole(String projectName, String repoName, String appId)	Finds RepositoryRole of the specified appId from the specified repoName in the specified projectName.
CompletableFuture<Token>	findTokenByAppId(String appId)	Returns a Token which has the specified appId.
CompletableFuture<Token>	findTokenBySecret(String secret)	Returns a Token which has the specified secret.
CompletableFuture<Member>	getMember(String projectName, User user)	Returns a Member if the specified User is a member of the specified projectName.
CompletableFuture<ProjectMetadata>	getProject(String projectName)	Returns a ProjectMetadata whose name equals to the specified projectName.
CompletableFuture<RepositoryMetadata>	getRepo(String projectName, String repoName)	Returns a RepositoryMetadata of the specified repoName in the specified projectName.
CompletableFuture<Tokens>	getTokens()	Returns a Tokens.
CompletableFuture<Revision>	purgeRepo(Author author, String projectName, String repoName)	Purges a RepositoryMetadata of the specified repoName from the specified projectName.
Revision	purgeToken(Author author, String appId)	Purges the Token of the specified appId that was removed before.
CompletableFuture<Revision>	removeMember(Author author, String projectName, User user)	Removes the specified user from the ProjectMetadata in the specified projectName.
CompletableFuture<Revision>	removeProject(Author author, String projectName)	Removes a ProjectMetadata whose name equals to the specified projectName.
CompletableFuture<Revision>	removeRepo(Author author, String projectName, String repoName)	Removes a RepositoryMetadata of the specified repoName from the specified projectName.
CompletableFuture<Revision>	removeToken(Author author, String projectName, Token token)	Removes the specified Token from the specified projectName.
CompletableFuture<Revision>	removeToken(Author author, String projectName, String appId)	Removes the Token of the specified appId from the specified projectName.
CompletableFuture<Revision>	removeTokenRepositoryRole(Author author, String projectName, String repoName, String appId)	Removes the RepositoryRole for the Token of the specified appId of the specified repoName in the specified projectName.
CompletableFuture<Revision>	removeUserRepositoryRole(Author author, String projectName, String repoName, User member)	Removes the RepositoryRole for the specified member from the specified repoName in the specified projectName.
CompletableFuture<Revision>	restoreProject(Author author, String projectName)	Restores a ProjectMetadata whose name equals to the specified projectName.
CompletableFuture<Revision>	restoreRepo(Author author, String projectName, String repoName)	Restores a RepositoryMetadata of the specified repoName in the specified projectName.
CompletableFuture<Revision>	updateMemberRole(Author author, String projectName, User member, ProjectRole projectRole)	Updates a ProjectRole for the specified member in the specified projectName.
CompletableFuture<Revision>	updateRepositoryProjectRoles(Author author, String projectName, String repoName, ProjectRoles projectRoles)	Updates the member and guest RepositoryRole of the specified repoName in the specified projectName.
CompletableFuture<Revision>	updateTokenLevel(Author author, String appId, boolean toBeSystemAdmin)	Update the Token of the specified appId to user or admin.
CompletableFuture<Revision>	updateTokenRepositoryRole(Author author, String projectName, String repoName, String appId, RepositoryRole role)	Updates the RepositoryRole for the Token of the specified appId of the specified repoName in the specified projectName.
CompletableFuture<Revision>	updateTokenRole(Author author, String projectName, Token token, ProjectRole role)	Updates a ProjectRole for the Token of the specified appId.
CompletableFuture<Revision>	updateUserRepositoryRole(Author author, String projectName, String repoName, User member, RepositoryRole role)	Updates the RepositoryRole for the specified member of the specified repoName in the specified projectName.
CompletableFuture<Revision>	updateWriteQuota(Author author, String projectName, String repoName, QuotaConfig writeQuota)	Updates the write quota for the specified repoName in the specified projectName.

Methods inherited from class java.lang.Object

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

Field Details

METADATA_JSON

public static final String METADATA_JSON

A path of metadata file.

See Also:

• Constant Field Values

TOKEN_JSON

public static final String TOKEN_JSON

A path of token list file.

See Also:

• Constant Field Values

Constructor Details

MetadataService

public MetadataService(ProjectManager projectManager,
 CommandExecutor executor)

Creates a new instance.

Method Details

getProject

public CompletableFuture<ProjectMetadata> getProject(String projectName)

Returns a ProjectMetadata whose name equals to the specified projectName.

removeProject

public CompletableFuture<Revision> removeProject(Author author,
 String projectName)

Removes a ProjectMetadata whose name equals to the specified projectName.

restoreProject

public CompletableFuture<Revision> restoreProject(Author author,
 String projectName)

Restores a ProjectMetadata whose name equals to the specified projectName.

getMember

public CompletableFuture<Member> getMember(String projectName,
 User user)

Returns a Member if the specified User is a member of the specified projectName.

addMember

public CompletableFuture<Revision> addMember(Author author,
 String projectName,
 User member,
 ProjectRole projectRole)

Adds the specified member to the ProjectMetadata of the specified projectName with the specified projectRole.

removeMember

public CompletableFuture<Revision> removeMember(Author author,
 String projectName,
 User user)

Removes the specified user from the ProjectMetadata in the specified projectName. It also removes the RepositoryRole of the specified user from every RepositoryMetadata.

updateMemberRole

public CompletableFuture<Revision> updateMemberRole(Author author,
 String projectName,
 User member,
 ProjectRole projectRole)

Updates a ProjectRole for the specified member in the specified projectName.

getRepo

public CompletableFuture<RepositoryMetadata> getRepo(String projectName,
 String repoName)

Returns a RepositoryMetadata of the specified repoName in the specified projectName.

addRepo

public CompletableFuture<Revision> addRepo(Author author,
 String projectName,
 String repoName)

Adds a RepositoryMetadata of the specified repoName to the specified projectName with a default RepositoryRole. The member will have the RepositoryRole.WRITE role and the guest won't have any role.

addRepo

public CompletableFuture<Revision> addRepo(Author author,
 String projectName,
 String repoName,
 ProjectRoles projectRoles)

Adds a RepositoryMetadata of the specified repoName to the specified projectName with the specified ProjectRoles.

removeRepo

public CompletableFuture<Revision> removeRepo(Author author,
 String projectName,
 String repoName)

Removes a RepositoryMetadata of the specified repoName from the specified projectName.

purgeRepo

public CompletableFuture<Revision> purgeRepo(Author author,
 String projectName,
 String repoName)

Purges a RepositoryMetadata of the specified repoName from the specified projectName.

restoreRepo

public CompletableFuture<Revision> restoreRepo(Author author,
 String projectName,
 String repoName)

Restores a RepositoryMetadata of the specified repoName in the specified projectName.

updateRepositoryProjectRoles

public CompletableFuture<Revision> updateRepositoryProjectRoles(Author author,
 String projectName,
 String repoName,
 ProjectRoles projectRoles)

Updates the member and guest RepositoryRole of the specified repoName in the specified projectName.

addToken

public CompletableFuture<Revision> addToken(Author author,
 String projectName,
 Token token,
 ProjectRole role)

Adds the specified Token to the specified projectName.

addToken

public CompletableFuture<Revision> addToken(Author author,
 String projectName,
 String appId,
 ProjectRole role)

Adds a Token of the specified appId to the specified projectName.

removeToken

public CompletableFuture<Revision> removeToken(Author author,
 String projectName,
 Token token)

Removes the specified Token from the specified projectName. It also removes every token repository role belonging to the Token from every RepositoryMetadata.

removeToken

public CompletableFuture<Revision> removeToken(Author author,
 String projectName,
 String appId)

Removes the Token of the specified appId from the specified projectName. It also removes every token repository role belonging to Token from every RepositoryMetadata.

updateTokenRole

public CompletableFuture<Revision> updateTokenRole(Author author,
 String projectName,
 Token token,
 ProjectRole role)

Updates a ProjectRole for the Token of the specified appId.

addUserRepositoryRole

public CompletableFuture<Revision> addUserRepositoryRole(Author author,
 String projectName,
 String repoName,
 User member,
 RepositoryRole role)

Adds the RepositoryRole for the specified member to the specified repoName in the specified projectName.

removeUserRepositoryRole

public CompletableFuture<Revision> removeUserRepositoryRole(Author author,
 String projectName,
 String repoName,
 User member)

Removes the RepositoryRole for the specified member from the specified repoName in the specified projectName.

updateUserRepositoryRole

public CompletableFuture<Revision> updateUserRepositoryRole(Author author,
 String projectName,
 String repoName,
 User member,
 RepositoryRole role)

Updates the RepositoryRole for the specified member of the specified repoName in the specified projectName.

addTokenRepositoryRole

public CompletableFuture<Revision> addTokenRepositoryRole(Author author,
 String projectName,
 String repoName,
 String appId,
 RepositoryRole role)

Adds the RepositoryRole for the Token of the specified appId to the specified repoName in the specified projectName.

removeTokenRepositoryRole

public CompletableFuture<Revision> removeTokenRepositoryRole(Author author,
 String projectName,
 String repoName,
 String appId)

Removes the RepositoryRole for the Token of the specified appId of the specified repoName in the specified projectName.

updateTokenRepositoryRole

public CompletableFuture<Revision> updateTokenRepositoryRole(Author author,
 String projectName,
 String repoName,
 String appId,
 RepositoryRole role)

Updates the RepositoryRole for the Token of the specified appId of the specified repoName in the specified projectName.

updateWriteQuota

public CompletableFuture<Revision> updateWriteQuota(Author author,
 String projectName,
 String repoName,
 QuotaConfig writeQuota)

Updates the write quota for the specified repoName in the specified projectName.

findRepositoryRole

public CompletableFuture<RepositoryRole> findRepositoryRole(String projectName,
 String repoName,
 User user)

Finds RepositoryRole of the specified User or UserWithToken from the specified repoName in the specified projectName. If the User is not found, it will return null.

findRepositoryRole

public CompletableFuture<RepositoryRole> findRepositoryRole(String projectName,
 String repoName,
 String appId)

Finds RepositoryRole of the specified appId from the specified repoName in the specified projectName. If the appId is not found, it will return null.

findProjectRole

public CompletableFuture<ProjectRole> findProjectRole(String projectName,
 User user)

Finds a ProjectRole of the specified User in the specified projectName.

getTokens

public CompletableFuture<Tokens> getTokens()

Returns a Tokens.

createToken

public CompletableFuture<Revision> createToken(Author author,
 String appId)

Creates a new user-level Token with the specified appId. A secret for the appId will be automatically generated.

createToken

public CompletableFuture<Revision> createToken(Author author,
 String appId,
 boolean isSystemAdmin)

Creates a new Token with the specified appId, isSystemAdmin and an auto-generated secret.

createToken

public CompletableFuture<Revision> createToken(Author author,
 String appId,
 String secret)

Creates a new user-level Token with the specified appId and secret.

createToken

public CompletableFuture<Revision> createToken(Author author,
 String appId,
 String secret,
 boolean isSystemAdmin)

Creates a new Token with the specified appId, secret and isSystemAdmin.

destroyToken

public CompletableFuture<Revision> destroyToken(Author author,
 String appId)

Removes the Token of the specified appId completely from the system.

purgeToken

public Revision purgeToken(Author author,
 String appId)

Purges the Token of the specified appId that was removed before.

Note that this is a blocking method that should not be invoked in an event loop.

activateToken

public CompletableFuture<Revision> activateToken(Author author,
 String appId)

Activates the Token of the specified appId.

deactivateToken

public CompletableFuture<Revision> deactivateToken(Author author,
 String appId)

Deactivates the Token of the specified appId.

updateTokenLevel

public CompletableFuture<Revision> updateTokenLevel(Author author,
 String appId,
 boolean toBeSystemAdmin)

Update the Token of the specified appId to user or admin.

findTokenByAppId

public CompletableFuture<Token> findTokenByAppId(String appId)

Returns a Token which has the specified appId.

findTokenBySecret

public CompletableFuture<Token> findTokenBySecret(String secret)

Returns a Token which has the specified secret.