com.ibm.commerce.content.facade.client

Class ManagedDirectoryFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.content.facade.client.AbstractContentFacadeClient

com.ibm.commerce.content.facade.client.ManagedDirectoryFacadeClient

public class ManagedDirectoryFacadeClient
extends AbstractContentFacadeClient

This class provides common methods that this and other utility class to the managed directory facade can use. This class also provides a set of convenient Java API to represent particular Content operations. This set of Java API also includes APIs for Web based requests to transform the name value pair request into the appropriate request documents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
ManagedDirectoryFacadeClient() Creates an instance of the client to communicate with the managed directory facade.
ManagedDirectoryFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the managed directory facade.

Method Summary

Modifier and Type	Method and Description
ProcessManagedDirectoryType	createProcessManagedDirectory() This method returns a new instance of the ManagedDirectory object.
AcknowledgeManagedDirectoryType	processManagedDirectory(java.lang.String action, ManagedDirectoryType managedDirectory, java.lang.String expression) Processes a managed directory.

Methods inherited from class com.ibm.commerce.content.facade.client.AbstractContentFacadeClient

changeAttachment, changeContentVersion, changeFileUploadJob, changeManagedDirectory, changeManagedFile, changeTask, changeTaskGroup, changeWorkspace, getAttachment, getAttachment, getAttachment, getContentVersion, getContentVersion, getContentVersion, getExternalContent, getExternalContent, getExternalContent, getFileUploadJob, getFileUploadJob, getFileUploadJob, getManagedDirectory, getManagedDirectory, getManagedDirectory, getManagedFile, getManagedFile, getManagedFile, getTask, getTask, getTask, getTaskGroup, getTaskGroup, getTaskGroup, getWorkspace, getWorkspace, getWorkspace, processAttachment, processContentVersion, processFileUploadJob, processManagedDirectory, processManagedFile, processTask, processTaskGroup, processWorkspace

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ManagedDirectoryFacadeClient

public ManagedDirectoryFacadeClient()

Creates an instance of the client to communicate with the managed directory facade.

ManagedDirectoryFacadeClient

public ManagedDirectoryFacadeClient(BusinessContextType businessContext,
                                    javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the managed directory facade.

Parameters:

businessContext - The default business context to associate with the messages when making requests.

callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

processManagedDirectory

public AcknowledgeManagedDirectoryType processManagedDirectory(java.lang.String action,
                                                               ManagedDirectoryType managedDirectory,
                                                               java.lang.String expression)
                                                        throws ManagedDirectoryException

Processes a managed directory.

Parameters:

action - The action being executed.

managedDirectory - Contains data related to the managed directory being processed

expression - The expression

Returns:

The response AcknowledgeManagedDirectory

Throws:

ManagedDirectoryException - if an error occurs

createProcessManagedDirectory

public ProcessManagedDirectoryType createProcessManagedDirectory()

This method returns a new instance of the ManagedDirectory object. This object will be associated with a container object to convert the object into an XML document.

Returns:

A new instance of the ManagedDirectory object that is associated with a container.