com.marklogic.hub.deploy.commands

Class CreateGranularPrivilegesCommand

java.lang.Object

com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand

All Implemented Interfaces:

com.marklogic.appdeployer.command.Command, com.marklogic.appdeployer.command.UndoableCommand

public class CreateGranularPrivilegesCommand
extends java.lang.Object
implements com.marklogic.appdeployer.command.Command, com.marklogic.appdeployer.command.UndoableCommand

Command for creating granular privileges after the resources that these privileges depend on have been created.

Constructor Summary

Constructors

Constructor and Description
CreateGranularPrivilegesCommand(HubConfig hubConfig)
CreateGranularPrivilegesCommand(HubConfig hubConfig, java.util.List<java.lang.String> groupNames)

Method Summary

Modifier and Type	Method and Description
protected com.marklogic.mgmt.api.security.Privilege	buildPrivilege(com.marklogic.mgmt.ManageClient client, java.lang.String name, java.lang.String action, java.lang.String dhsName, java.util.List<java.lang.String> existingPrivilegeNames, java.lang.String role)
protected java.util.List<com.marklogic.mgmt.api.security.Privilege>	buildPrivilegesThatDhsMayHaveCreated(com.marklogic.mgmt.ManageClient client) Some of the privileges that need to be created may already exist in DHS.
protected java.util.List<com.marklogic.mgmt.api.security.Privilege>	buildScheduledTaskPrivileges() Builds a list of privileges to create based on the groupNames configured on this object.
void	execute(com.marklogic.appdeployer.command.CommandContext context)
java.lang.Integer	getExecuteSortOrder() It is anticipated that these privileges can always be added at the end of a deployment because none of the steps before that should depend on the privileges being added.
java.util.List<java.lang.String>	getGroupNames()
protected java.util.List<java.lang.String>	getGroupNamesForScheduledTaskPrivileges()
java.lang.Integer	getUndoSortOrder()
void	undo(com.marklogic.appdeployer.command.CommandContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateGranularPrivilegesCommand

public CreateGranularPrivilegesCommand(HubConfig hubConfig)

CreateGranularPrivilegesCommand

public CreateGranularPrivilegesCommand(HubConfig hubConfig,
                                       java.util.List<java.lang.String> groupNames)

Method Detail

getExecuteSortOrder

public java.lang.Integer getExecuteSortOrder()

It is anticipated that these privileges can always be added at the end of a deployment because none of the steps before that should depend on the privileges being added.

Specified by:

getExecuteSortOrder in interface com.marklogic.appdeployer.command.Command

Returns:

getUndoSortOrder

public java.lang.Integer getUndoSortOrder()

Specified by:

getUndoSortOrder in interface com.marklogic.appdeployer.command.UndoableCommand

execute

public void execute(com.marklogic.appdeployer.command.CommandContext context)

Specified by:

execute in interface com.marklogic.appdeployer.command.Command

undo

public void undo(com.marklogic.appdeployer.command.CommandContext context)

Specified by:

undo in interface com.marklogic.appdeployer.command.UndoableCommand

buildPrivilegesThatDhsMayHaveCreated

protected java.util.List<com.marklogic.mgmt.api.security.Privilege> buildPrivilegesThatDhsMayHaveCreated(com.marklogic.mgmt.ManageClient client)

Some of the privileges that need to be created may already exist in DHS. If so, then a role is added to that privilege instead of creating a duplicate one with the same action, which ML does not allow.

Parameters:

client -

Returns:

buildPrivilege

protected com.marklogic.mgmt.api.security.Privilege buildPrivilege(com.marklogic.mgmt.ManageClient client,
                                                                   java.lang.String name,
                                                                   java.lang.String action,
                                                                   java.lang.String dhsName,
                                                                   java.util.List<java.lang.String> existingPrivilegeNames,
                                                                   java.lang.String role)

buildScheduledTaskPrivileges

protected java.util.List<com.marklogic.mgmt.api.security.Privilege> buildScheduledTaskPrivileges()

Builds a list of privileges to create based on the groupNames configured on this object. If none have been configured, then the groupName in AppConfig is used.

Returns:

getGroupNamesForScheduledTaskPrivileges

protected java.util.List<java.lang.String> getGroupNamesForScheduledTaskPrivileges()

getGroupNames

public java.util.List<java.lang.String> getGroupNames()