001 /*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License"). You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import org.opends.server.admin.Configuration;
032 import org.opends.server.admin.server.ConfigurationChangeListener;
033 import org.opends.server.types.DN;
034
035
036
037 /**
038 * A server-side interface for querying Workflow settings.
039 * <p>
040 * The Workflow is a list of processing steps (Work Flow Elements)
041 * that are applied to data as it is retrieved from the Directory
042 * Server.
043 */
044 public interface WorkflowCfg extends Configuration {
045
046 /**
047 * Gets the configuration class associated with this Workflow.
048 *
049 * @return Returns the configuration class associated with this Workflow.
050 */
051 Class<? extends WorkflowCfg> configurationClass();
052
053
054
055 /**
056 * Register to be notified when this Workflow is changed.
057 *
058 * @param listener
059 * The Workflow configuration change listener.
060 */
061 void addChangeListener(ConfigurationChangeListener<WorkflowCfg> listener);
062
063
064
065 /**
066 * Deregister an existing Workflow configuration change listener.
067 *
068 * @param listener
069 * The Workflow configuration change listener.
070 */
071 void removeChangeListener(ConfigurationChangeListener<WorkflowCfg> listener);
072
073
074
075 /**
076 * Gets the "base-dn" property.
077 * <p>
078 * Specifies the base DN of the data targeted by the Workflow .
079 *
080 * @return Returns the value of the "base-dn" property.
081 */
082 DN getBaseDN();
083
084
085
086 /**
087 * Gets the "enabled" property.
088 * <p>
089 * Indicates whether the Workflow is enabled for use in the server.
090 * <p>
091 * If a Workflow is not enabled, then its contents are not
092 * accessible when processing operations.
093 *
094 * @return Returns the value of the "enabled" property.
095 */
096 boolean isEnabled();
097
098
099
100 /**
101 * Gets the "workflow-element" property.
102 * <p>
103 * Specifies the root Work Flow Element in the Workflow .
104 *
105 * @return Returns the value of the "workflow-element" property.
106 */
107 String getWorkflowElement();
108
109
110
111 /**
112 * Gets the "workflow-element" property as a DN.
113 * <p>
114 * Specifies the root Work Flow Element in the Workflow .
115 *
116 * @return Returns the DN value of the "workflow-element" property.
117 */
118 DN getWorkflowElementDN();
119
120
121
122 /**
123 * Gets the "workflow-id" property.
124 * <p>
125 * Provides a name that identifies the Workflow.
126 * <p>
127 * The name must be unique among all Workflows in the server.
128 *
129 * @return Returns the value of the "workflow-id" property.
130 */
131 String getWorkflowId();
132
133 }