org.bonitasoft.engine.external.web.profile.command

Class ImportProfilesCommand

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.external.web.profile.command.ImportProfilesCommand

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class ImportProfilesCommand
extends TenantCommand

Specific Command to import profiles xml content as byte[]. "byte[]" : xml content

Author:

Zhao Na, Matthieu Chaffotte, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
ImportProfilesCommand()

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	execute(Map<String,Serializable> parameters, TenantServiceAccessor serviceAccessor) Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportProfilesCommand

public ImportProfilesCommand()

Method Detail

execute

public Serializable execute(Map<String,Serializable> parameters,
                   TenantServiceAccessor serviceAccessor)
                     throws SCommandParameterizationException,
                            SCommandExecutionException

Description copied from interface: Command

Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command. Implementors of commands must put here the code to be executed on the server side

Parameters:

parameters - a map of parameters that can be used by the command and that is given by the client when executing the command

serviceAccessor - the TenantServiceAccessor or PlatformServiceAccessor that provides access to the engine's server-side services

Returns:

a List is a warning message list in case of non-existing User, Group or Role to map the profile to.

Throws:

SCommandParameterizationException - can be thrown if insufficient or wrong parameters are given by the client

SCommandExecutionException - can be thrown when something unexpected happens while executing the command