FlowContainerUtils (DSpace XML-UI (Manakin) 6.0-rc2 API)

java.lang.Object
- org.dspace.app.xmlui.aspect.administrative.FlowContainerUtils

```
public class FlowContainerUtils
extends Object
```
Utility methods to processes actions on Communities and Collections.

Author:

Scott Phillips

Field Summary

Fields
Modifier and Type	Field and Description
`protected static AuthorizeService`	`authorizeService`
`protected static CollectionService`	`collectionService`
`protected static CommunityService`	`communityService`
`protected static GroupService`	`groupService`
`protected static HarvestedCollectionService`	`harvestedCollectionService`
`protected static ItemService`	`itemService`
`protected static ResourcePolicyService`	`resourcePolicyService`
`static String`	`ROLE_ADMIN` Possible Collection roles
`static String`	`ROLE_DEFAULT_READ`
`static String`	`ROLE_SUBMIT`
`static String`	`ROLE_WF_STEP1`
`static String`	`ROLE_WF_STEP2`
`static String`	`ROLE_WF_STEP3`
`protected static WorkflowService`	`workflowService`

Constructor Summary

Constructors
Constructor and Description

FlowContainerUtils()

Constructors
Constructor and Description
`FlowContainerUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static FlowResult`	`changeCollectionDefaultReadToAnonymous(Context context, UUID collectionID)` Change the default read privileges to the anonymous group.
`static String`	`checkXMLFragment(String value)` Check whether this metadata value is a proper XML fragment.
`static UUID`	`createCollectionDefaultReadGroup(Context context, UUID collectionID)` Change default privileges from the anonymous group to a new group that will be created and appropriate privileges assigned.
`static String`	`escapeXMLEntities(String value)` Sanitize any XML that was inputed by the user, this will clean up any unescaped characters so that they can be stored as proper XML.
`static Group`	`getCollectionDefaultRead(Context context, Collection collection)` Look up the id of a group authorized for one of the given roles.
`static UUID`	`getCollectionRole(Context context, UUID collectionID, String roleName)` Look up the id of a group authorized for one of the given roles.
`static UUID`	`getCommunityRole(Context context, UUID communityID, String roleName)` Look up the id of a group authorized for one of the given roles.
`static UUID`	`getTemplateItemID(Context context, UUID collectionID)` Look up the id of the template item for a given collection.
`static FlowResult`	`processCreateCollection(Context context, UUID communityID, org.apache.cocoon.environment.Request request)` Create a new collection
`static FlowResult`	`processCreateCommunity(Context context, UUID communityID, org.apache.cocoon.environment.Request request)` Create a new community.
`static FlowResult`	`processCurateCollection(Context context, UUID dsoID, org.apache.cocoon.environment.Request request)` processCurateCollection Utility method to process curation tasks submitted via the DSpace GUI
`static FlowResult`	`processCurateCommunity(Context context, UUID dsoID, org.apache.cocoon.environment.Request request)` Utility method to process curation tasks submitted via the DSpace GUI.
`static FlowResult`	`processDeleteCollection(Context context, UUID collectionID)` Delete collection itself
`static FlowResult`	`processDeleteCollectionRole(Context context, UUID collectionID, String roleName, UUID groupID)` Delete one of collection's roles
`static FlowResult`	`processDeleteCommunity(Context context, UUID communityID)` Delete community itself.
`static FlowResult`	`processDeleteCommunityRole(Context context, UUID communityID, String roleName, UUID groupID)` Delete one of a community's roles
`static FlowResult`	`processDeleteTemplateItem(Context context, UUID collectionID)` Delete a collection's template item (which is not a member of the collection).
`static FlowResult`	`processEditCollection(Context context, UUID collectionID, boolean deleteLogo, org.apache.cocoon.environment.Request request)` Process the collection metadata edit form.
`static FlowResult`	`processEditCommunity(Context context, UUID communityID, boolean deleteLogo, org.apache.cocoon.environment.Request request)` Process the community metadata edit form.
`static FlowResult`	`processQueueCollection(Context context, UUID dsoID, org.apache.cocoon.environment.Request request)` Queues curation tasks.
`static FlowResult`	`processQueueCommunity(Context context, UUID dsoID, org.apache.cocoon.environment.Request request)` queues curation tasks.
`static FlowResult`	`processReimportCollection(Context context, UUID collectionID, org.apache.cocoon.environment.Request request)` Purge the collection of all items, then run a fresh harvest cycle.
`static FlowResult`	`processRunCollectionHarvest(Context context, UUID collectionID, org.apache.cocoon.environment.Request request)` Use the collection's harvest settings to immediately perform a harvest cycle.
`static FlowResult`	`processSetupCollectionHarvesting(Context context, UUID collectionID, org.apache.cocoon.environment.Request request)` Process the collection harvesting options form.
`static FlowResult`	`testOAISettings(Context context, org.apache.cocoon.environment.Request request)` Test the supplied OAI settings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE_ADMIN
```
public static final String ROLE_ADMIN
```
Possible Collection roles

See Also:
Constant Field Values

ROLE_WF_STEP1

public static final String ROLE_WF_STEP1

See Also:: Constant Field Values

ROLE_WF_STEP2

public static final String ROLE_WF_STEP2

See Also:: Constant Field Values

ROLE_WF_STEP3

public static final String ROLE_WF_STEP3

See Also:: Constant Field Values

ROLE_SUBMIT
```
public static final String ROLE_SUBMIT
```
See Also:
Constant Field Values

ROLE_DEFAULT_READ

public static final String ROLE_DEFAULT_READ

See Also:: Constant Field Values

authorizeService

protected static final AuthorizeService authorizeService

resourcePolicyService

protected static final ResourcePolicyService resourcePolicyService

communityService

protected static final CommunityService communityService

collectionService

protected static final CollectionService collectionService

itemService

protected static final ItemService itemService

groupService

protected static final GroupService groupService

harvestedCollectionService

protected static final HarvestedCollectionService harvestedCollectionService

workflowService

protected static final WorkflowService workflowService

Constructor Detail
- FlowContainerUtils
```
public FlowContainerUtils()
```

Method Detail

processEditCollection

public static FlowResult processEditCollection(Context context,
                               UUID collectionID,
                               boolean deleteLogo,
                               org.apache.cocoon.environment.Request request)
                                        throws SQLException,
                                               IOException,
                                               AuthorizeException

Process the collection metadata edit form.

Parameters:: context - The current DSpace context.; collectionID - The collection id.; deleteLogo - Determines if the logo should be deleted along with the metadata editing action.; request - the Cocoon request object
Returns:: A process result's object.
Throws:: SQLException - passed through.; IOException - passed through.; AuthorizeException - passed through.

processSetupCollectionHarvesting

public static FlowResult processSetupCollectionHarvesting(Context context,
                                          UUID collectionID,
                                          org.apache.cocoon.environment.Request request)
                                                   throws SQLException,
                                                          IOException,
                                                          AuthorizeException

Process the collection harvesting options form.

Parameters:: context - The current DSpace context.; collectionID - The collection id.; request - the Cocoon request object
Returns:: A process result's object.
Throws:: SQLException - passed through.; IOException - passed through.; AuthorizeException - passed through.

processRunCollectionHarvest

public static FlowResult processRunCollectionHarvest(Context context,
                                     UUID collectionID,
                                     org.apache.cocoon.environment.Request request)
                                              throws SQLException,
                                                     IOException,
                                                     AuthorizeException,
                                                     CrosswalkException,
                                                     ParserConfigurationException,
                                                     SAXException,
                                                     TransformerException

Use the collection's harvest settings to immediately perform a harvest cycle.

Parameters:: context - The current DSpace context.; collectionID - The collection id.; request - the Cocoon request object
Returns:: A process result's object.
Throws:: SQLException - passed through.; IOException - passed through.; AuthorizeException - passed through.; TransformerException - passed through.; SAXException - passed through.; ParserConfigurationException - passed through.; CrosswalkException - passed through.

processReimportCollection

public static FlowResult processReimportCollection(Context context,
                                   UUID collectionID,
                                   org.apache.cocoon.environment.Request request)
                                            throws SQLException,
                                                   IOException,
                                                   AuthorizeException,
                                                   CrosswalkException,
                                                   ParserConfigurationException,
                                                   SAXException,
                                                   TransformerException,
                                                   BrowseException

Purge the collection of all items, then run a fresh harvest cycle.

Parameters:: context - The current DSpace context.; collectionID - The collection id.; request - the Cocoon request object
Returns:: A process result's object.
Throws:: SQLException - passed through.; IOException - passed through.; AuthorizeException - passed through.; TransformerException - passed through.; SAXException - passed through.; ParserConfigurationException - passed through.; CrosswalkException - passed through.; BrowseException - passed through.

testOAISettings

public static FlowResult testOAISettings(Context context,
                         org.apache.cocoon.environment.Request request)

Test the supplied OAI settings.

Parameters:: context - session context.; request - user's request.
Returns:: result of testing.

getTemplateItemID

public static UUID getTemplateItemID(Context context,
                     UUID collectionID)
                              throws SQLException,
                                     AuthorizeException,
                                     IOException

Look up the id of the template item for a given collection.

Parameters:: context - The current DSpace context.; collectionID - The collection id.
Returns:: The id of the template item.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.

getCollectionRole

public static UUID getCollectionRole(Context context,
                     UUID collectionID,
                     String roleName)
                              throws SQLException,
                                     AuthorizeException,
                                     IOException,
                                     TransformerException,
                                     SAXException,
                                     WorkflowConfigurationException,
                                     ParserConfigurationException,
                                     WorkflowException

Look up the id of a group authorized for one of the given roles. If no group is currently authorized to perform this role then a new group will be created and assigned the role.

Parameters:: context - The current DSpace context.; collectionID - The collection id.; roleName - ADMIN, WF_STEP1, WF_STEP2, WF_STEP3, SUBMIT, DEFAULT_READ.
Returns:: The id of the group associated with that particular role, or -1 if the role was not found.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.; TransformerException - passed through.; SAXException - passed through.; WorkflowConfigurationException - passed through.; ParserConfigurationException - passed through.; WorkflowException - passed through.

processDeleteCollectionRole

public static FlowResult processDeleteCollectionRole(Context context,
                                     UUID collectionID,
                                     String roleName,
                                     UUID groupID)
                                              throws SQLException,
                                                     UIException,
                                                     IOException,
                                                     AuthorizeException,
                                                     WorkflowConfigurationException

Delete one of collection's roles

Parameters:: context - The current DSpace context.; collectionID - The collection id.; roleName - ADMIN, WF_STEP1, WF_STEP2, WF_STEP3, SUBMIT, DEFAULT_READ.; groupID - The id of the group associated with this role.
Returns:: A process result's object.
Throws:: SQLException - passed through.; UIException - passed through.; IOException - passed through.; WorkflowConfigurationException - passed through.; AuthorizeException - passed through.

getCollectionDefaultRead
```
public static Group getCollectionDefaultRead(Context context,
                             Collection collection)
                                      throws SQLException,
                                             AuthorizeException
```
Look up the id of a group authorized for one of the given roles. If no group is currently authorized to perform this role then a new group will be created and assigned the role.

Parameters:
context - The current DSpace context.
collection - The collection.

Returns:
The id of the group associated with that particular role or -1

Throws:

SQLException - passed through.

AuthorizeException - passed through.

createCollectionDefaultReadGroup

public static UUID createCollectionDefaultReadGroup(Context context,
                                    UUID collectionID)
                                             throws SQLException,
                                                    AuthorizeException,
                                                    UIException

Change default privileges from the anonymous group to a new group that will be created and appropriate privileges assigned. The id of this new group will be returned.

Parameters:: context - The current DSpace context.; collectionID - The collection id.
Returns:: The group ID of the new group.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; UIException - passed through.

changeCollectionDefaultReadToAnonymous

public static FlowResult changeCollectionDefaultReadToAnonymous(Context context,
                                                UUID collectionID)
                                                         throws SQLException,
                                                                AuthorizeException,
                                                                UIException,
                                                                IOException

Change the default read privileges to the anonymous group. If getCollectionDefaultRead() returns -1 or the anonymous group then nothing is done.

Parameters:: context - The current DSpace context.; collectionID - The collection id.
Returns:: A process result's object.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; UIException - passed through.; IOException - passed through.

processDeleteCollection

public static FlowResult processDeleteCollection(Context context,
                                 UUID collectionID)
                                          throws SQLException,
                                                 AuthorizeException,
                                                 IOException

Delete collection itself

Parameters:: context - The current DSpace context.; collectionID - The collection id.
Returns:: A process result's object.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.

processCreateCollection

public static FlowResult processCreateCollection(Context context,
                                 UUID communityID,
                                 org.apache.cocoon.environment.Request request)
                                          throws SQLException,
                                                 AuthorizeException,
                                                 IOException

Create a new collection

Parameters:: context - The current DSpace context.; communityID - The id of the parent community.; request - user's request.
Returns:: A process result's object.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.

processCreateCommunity

public static FlowResult processCreateCommunity(Context context,
                                UUID communityID,
                                org.apache.cocoon.environment.Request request)
                                         throws AuthorizeException,
                                                IOException,
                                                SQLException

Create a new community.

Parameters:: context - The current DSpace context.; communityID - The id of the parent community (-1 for a top-level community).; request - user's request.
Returns:: A process result's object.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.

processEditCommunity

public static FlowResult processEditCommunity(Context context,
                              UUID communityID,
                              boolean deleteLogo,
                              org.apache.cocoon.environment.Request request)
                                       throws AuthorizeException,
                                              IOException,
                                              SQLException

Process the community metadata edit form.

Parameters:: context - The current DSpace context.; communityID - The community id.; deleteLogo - Determines if the logo should be deleted along with the metadata editing action.; request - the Cocoon request object
Returns:: A process result's object.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.

processDeleteCommunity

public static FlowResult processDeleteCommunity(Context context,
                                UUID communityID)
                                         throws SQLException,
                                                AuthorizeException,
                                                IOException

Delete community itself.

Parameters:: context - The current DSpace context.; communityID - The community id.
Returns:: A process result's object.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.

getCommunityRole
```
public static UUID getCommunityRole(Context context,
                    UUID communityID,
                    String roleName)
                             throws SQLException,
                                    AuthorizeException,
                                    IOException
```
Look up the id of a group authorized for one of the given roles. If no group is currently authorized to perform this role then a new group will be created and assigned the role.

Parameters:
context - The current DSpace context.
communityID - The collection id.
roleName - ADMIN.

Returns:
The id of the group associated with that particular role, or -1 if the role was not found.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

IOException - passed through.

processDeleteCommunityRole

public static FlowResult processDeleteCommunityRole(Context context,
                                    UUID communityID,
                                    String roleName,
                                    UUID groupID)
                                             throws SQLException,
                                                    UIException,
                                                    IOException,
                                                    AuthorizeException

Delete one of a community's roles

Parameters:: context - The current DSpace context.; communityID - The community id.; roleName - ADMIN.; groupID - The id of the group associated with this role.
Returns:: A process result's object.
Throws:: SQLException - passed through.; UIException - passed through.; IOException - passed through.; AuthorizeException - passed through.

processDeleteTemplateItem

public static FlowResult processDeleteTemplateItem(Context context,
                                   UUID collectionID)
                                            throws SQLException,
                                                   AuthorizeException,
                                                   IOException

Delete a collection's template item (which is not a member of the collection).

Parameters:: context - session context.; collectionID - the collection.
Returns:: continuation result.
Throws:: SQLException - passed through.; AuthorizeException - passed through.; IOException - passed through.

processCurateCollection

public static FlowResult processCurateCollection(Context context,
                                 UUID dsoID,
                                 org.apache.cocoon.environment.Request request)
                                          throws AuthorizeException,
                                                 IOException,
                                                 SQLException,
                                                 Exception

processCurateCollection Utility method to process curation tasks submitted via the DSpace GUI

Parameters:: context - session context.; dsoID - the object to be curated.; request - user's request.
Returns:: flow result.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.; Exception

processQueueCollection

public static FlowResult processQueueCollection(Context context,
                                UUID dsoID,
                                org.apache.cocoon.environment.Request request)
                                         throws AuthorizeException,
                                                IOException,
                                                SQLException,
                                                Exception

Queues curation tasks.

Parameters:: context - session context.; dsoID - the object to be curated.; request - user's request.
Returns:: flow result.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.; Exception

processCurateCommunity

public static FlowResult processCurateCommunity(Context context,
                                UUID dsoID,
                                org.apache.cocoon.environment.Request request)
                                         throws AuthorizeException,
                                                IOException,
                                                SQLException,
                                                Exception

Utility method to process curation tasks submitted via the DSpace GUI.

Parameters:: context - session context.; dsoID - object to be curated.; request - user's request
Returns:: flow result.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.; Exception

processQueueCommunity

public static FlowResult processQueueCommunity(Context context,
                               UUID dsoID,
                               org.apache.cocoon.environment.Request request)
                                        throws AuthorizeException,
                                               IOException,
                                               SQLException,
                                               Exception

queues curation tasks.

Parameters:: context - session context.; dsoID - object to be curated.; request - user's request.
Returns:: flow result.
Throws:: AuthorizeException - passed through.; IOException - passed through.; SQLException - passed through.; Exception

checkXMLFragment
```
public static String checkXMLFragment(String value)
```
Check whether this metadata value is a proper XML fragment. If the value is not then an error message will be returned that might (sometimes not) tell the user how to correct the problem.

Parameters:
value - The metadata value

Returns:
An error string of the problem or null if there is no problem with the metadata value.

escapeXMLEntities
```
public static String escapeXMLEntities(String value)
```
Sanitize any XML that was inputed by the user, this will clean up any unescaped characters so that they can be stored as proper XML. These are errors that in general we want to take care of on behalf of the user.

Parameters:
value - The unsanitized value

Returns:
A sanitized value

Class FlowContainerUtils