de.espirit.firstspirit.access

Class AccessUtil

java.lang.Object

de.espirit.firstspirit.access.AccessUtil

public class AccessUtil
extends Object

Utitly class providing methods for Access-API operations like server release, server delete

Since:

2.3.17

Constructor Summary

Constructors

Constructor and Description
AccessUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	cleanUpName(String name) Remove illegal chars from a name.
static <T extends StoreElement> T	copyStoreElement(T element, StoreElement parent) Creates a copy of the given element below the parent.
static ServerActionHandle<? extends DeleteProgress,Boolean>	delete(Collection<IDProvider> elements, boolean ignoreReferences) Deletes all elements on the server.
static ServerActionHandle<? extends DeleteProgress,Boolean>	delete(IDProvider element, boolean ignoreReferences) Deletes the the subtree specified by the given element on the server.
static int	executeProcess(Writer out, Writer err, String... command) Execute a programm in a native process.
static Language	getLanguageForKey(Project project, String languageKey)
static Language	getLanguageForKeyNotNull(Project project, String languageKey)
static ServerActionHandle<? extends ReleaseProgress,Boolean>	release(IDProvider toRelease, boolean checkOnly) Performs the default release on the server for the given IDProvider and following type specific options: recursive = false, except for Page and GCAPage releaseParentPath = false, except for Media, Page and GCAPage dependentRelease = NO_DEPENDENT_RELEASE
static ServerActionHandle<? extends ReleaseProgress,Boolean>	release(IDProvider releaseStartNode, boolean checkOnly, boolean ensureAccessibility, boolean recursive, IDProvider.DependentReleaseType dependentType) Starts the server release action for the given element with the given release options.
static ServerActionHandle<? extends ReleaseProgress,Boolean>	release(IDProvider releaseStartNode, boolean checkOnly, boolean ensureAccessibility, boolean recursive, IDProvider.DependentReleaseType dependentType, String comment) Starts the server release action for the given element with the given release options.
static ServerActionHandle<? extends ReleaseProgress,Boolean>	release(IDProvider toRelease, boolean checkOnly, String comment) Performs the default release on the server for the given IDProvider and following type specific options: recursive = false, except for Page and GCAPage releaseParentPath = false, except for Media, Page and GCAPage dependentRelease = NO_DEPENDENT_RELEASE
static ServerActionHandle<? extends RestoreProgress,Boolean>	restore(IDProvider newParent, ElementInfo elementInfo, boolean restoreParentIfNecessary, boolean ignoreMissingReferencedObjects, boolean checkOnlyMode) Starts a restore action on the server, which restores the deleted element specified by the given elementInfo
static ServerActionHandle<? extends RevertProgress,Boolean>	revert(IDProvider element, Revision revision, boolean recursive, EnumSet<IDProvider.RevertType> ignoreRevertTypes, boolean ignoreMissingReferencedObjects, boolean checkOnlyMode)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessUtil

public AccessUtil()

Method Detail

copyStoreElement

public static <T extends StoreElement> T copyStoreElement(T element,
                                          StoreElement parent)
                                               throws IOException

Creates a copy of the given element below the parent.

Parameters:

element - The element to copy

parent - The parent of the new element

Returns:

The new StoreElement

Throws:

IOException - thrown during temp-file operations.

Since:

4.0.17

cleanUpName

public static String cleanUpName(String name)

Remove illegal chars from a name.

Parameters:

name - The name

Returns:

name without illegal chars

Since:

3.0.112

release

public static ServerActionHandle<? extends ReleaseProgress,Boolean> release(IDProvider toRelease,
                                                            boolean checkOnly)

Performs the default release on the server for the given IDProvider and following type specific options:

• recursive = false, except for Page and GCAPage
• releaseParentPath = false, except for Media, Page and GCAPage
• dependentRelease = NO_DEPENDENT_RELEASE

Parameters:

toRelease - the startnode of release

checkOnly - if true release would not be processed

Returns:

the handle to the belonging server action which is started on the server

Throws:

IllegalArgumentException - if given releaseStartNode doesn't support release

Since:

4.0.13

release

public static ServerActionHandle<? extends ReleaseProgress,Boolean> release(IDProvider toRelease,
                                                            boolean checkOnly,
                                                            String comment)

Performs the default release on the server for the given IDProvider and following type specific options:

• recursive = false, except for Page and GCAPage
• releaseParentPath = false, except for Media, Page and GCAPage
• dependentRelease = NO_DEPENDENT_RELEASE

Parameters:

toRelease - the startnode of release

checkOnly - if true release would not be processed

comment - the release comment, may be null

Returns:

the handle to the belonging server action which is started on the server

Throws:

IllegalArgumentException - if given releaseStartNode doesn't support release

Since:

4.0.120

release

public static ServerActionHandle<? extends ReleaseProgress,Boolean> release(IDProvider releaseStartNode,
                                                            boolean checkOnly,
                                                            boolean ensureAccessibility,
                                                            boolean recursive,
                                                            IDProvider.DependentReleaseType dependentType)

Starts the server release action for the given element with the given release options.

Parameters:

releaseStartNode - the startnode of the release

checkOnly - if true release would not be processed

ensureAccessibility - if true each element on the parent path of the given releaseStartNode will be released which has never been released

recursive - if true the subtree of given releaseStartNode will be released recursive

dependentType - the dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see IDProvider.DependentReleaseType for details) if null then IDProvider.DependentReleaseType.NO_DEPENDENT_RELEASE is used

Returns:

the handle to the belonging server action which is started on the server

Throws:

IllegalArgumentException - if given releaseStartNode doesn't support release

Since:

4.0.13

See Also:

IDProvider.DependentReleaseType

release

public static ServerActionHandle<? extends ReleaseProgress,Boolean> release(IDProvider releaseStartNode,
                                                            boolean checkOnly,
                                                            boolean ensureAccessibility,
                                                            boolean recursive,
                                                            IDProvider.DependentReleaseType dependentType,
                                                            String comment)

Starts the server release action for the given element with the given release options.

Parameters:

releaseStartNode - the startnode of the release

checkOnly - if true release would not be processed

ensureAccessibility - if true each element on the parent path of the given releaseStartNode will be released which has never been released

dependentType - the dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see IDProvider.DependentReleaseType for details) if null then IDProvider.DependentReleaseType.NO_DEPENDENT_RELEASE is used

comment - the release comment, may be null

Returns:

the handle to the belonging server action which is started on the server

Throws:

IllegalArgumentException - if given releaseStartNode doesn't support release

Since:

4.0.120

See Also:

IDProvider.DependentReleaseType

restore

public static ServerActionHandle<? extends RestoreProgress,Boolean> restore(@NotNull
                                                            IDProvider newParent,
                                                            @NotNull
                                                            ElementInfo elementInfo,
                                                            boolean restoreParentIfNecessary,
                                                            boolean ignoreMissingReferencedObjects,
                                                            boolean checkOnlyMode)
                                                                     throws WorkflowLockException

Starts a restore action on the server, which restores the deleted element specified by the given elementInfo

Parameters:

newParent - the parent node, the restored node should be added as child

checkOnlyMode - use false to test the restore of the element, progress of returned handle will contain infos about the restore test

Returns:

a server action handle to the server restore action

Throws:

WorkflowLockException

Since:

4.0.57

See Also:

Store.getDeletedChilds()

revert

public static ServerActionHandle<? extends RevertProgress,Boolean> revert(IDProvider element,
                                                          Revision revision,
                                                          boolean recursive,
                                                          EnumSet<IDProvider.RevertType> ignoreRevertTypes,
                                                          boolean ignoreMissingReferencedObjects,
                                                          boolean checkOnlyMode)
                                                                   throws WorkflowLockException

Throws:

WorkflowLockException

Since:

4.0.120

delete

public static ServerActionHandle<? extends DeleteProgress,Boolean> delete(IDProvider element,
                                                          boolean ignoreReferences)

Deletes the the subtree specified by the given element on the server. The strategy is to delete as much as possible. Elements which couldn't be deleted because of missing permissions, lock failed, incoming references, etc. will be skipped.

Parameters:

element - the element to delete

ignoreReferences - use true to delete elements ignoring incoming references, if false elements which are referenced will be skipped

Returns:

The action handle.

Since:

4.0.120

delete

public static ServerActionHandle<? extends DeleteProgress,Boolean> delete(Collection<IDProvider> elements,
                                                          boolean ignoreReferences)

Deletes all elements on the server. The strategy is to delete as much as possible. Elements which couldn't be deleted because of missing permissions, lock failed, incoming references, etc. will be skipped.

Parameters:

elements - the elements to delete

ignoreReferences - use true to delete elements ignoring incoming references, if false elements which are referenced will be skipped

Returns:

The action handle.

Since:

5.0.34

getLanguageForKey

public static Language getLanguageForKey(Project project,
                         String languageKey)

Since:

4.0.17

getLanguageForKeyNotNull

@NotNull
public static Language getLanguageForKeyNotNull(Project project,
                                        String languageKey)

Since:

4.0.41

executeProcess

public static int executeProcess(Writer out,
                 Writer err,
                 String... command)
                          throws IOException

Execute a programm in a native process.

Parameters:

out - the output writer the process will append its output to. Writer will be closed after execution.

err - the error writer the process will append its error output to. Writer will be closed after execution.

command - the program and its arguments

Returns:

the exit code of the process

Throws:

IOException - if process creation fails

Since:

4.0.19