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.server.ConfigurationChangeListener; 032 import org.opends.server.types.DN; 033 034 035 036 /** 037 * A server-side interface for querying Local Backend Workflow Element 038 * settings. 039 * <p> 040 * The Local Backend Workflow Element provides access to a backend. 041 */ 042 public interface LocalBackendWorkflowElementCfg extends WorkflowElementCfg { 043 044 /** 045 * Gets the configuration class associated with this Local Backend Workflow Element. 046 * 047 * @return Returns the configuration class associated with this Local Backend Workflow Element. 048 */ 049 Class<? extends LocalBackendWorkflowElementCfg> configurationClass(); 050 051 052 053 /** 054 * Register to be notified when this Local Backend Workflow Element is changed. 055 * 056 * @param listener 057 * The Local Backend Workflow Element configuration change listener. 058 */ 059 void addLocalBackendChangeListener(ConfigurationChangeListener<LocalBackendWorkflowElementCfg> listener); 060 061 062 063 /** 064 * Deregister an existing Local Backend Workflow Element configuration change listener. 065 * 066 * @param listener 067 * The Local Backend Workflow Element configuration change listener. 068 */ 069 void removeLocalBackendChangeListener(ConfigurationChangeListener<LocalBackendWorkflowElementCfg> listener); 070 071 072 073 /** 074 * Gets the "backend" property. 075 * <p> 076 * Identifies the backend accessed by the workflow element. 077 * 078 * @return Returns the value of the "backend" property. 079 */ 080 String getBackend(); 081 082 083 084 /** 085 * Gets the "backend" property as a DN. 086 * <p> 087 * Identifies the backend accessed by the workflow element. 088 * 089 * @return Returns the DN value of the "backend" property. 090 */ 091 DN getBackendDN(); 092 093 094 095 /** 096 * Gets the "java-class" property. 097 * <p> 098 * Specifies the fully-qualified name of the Java class that 099 * provides the Local Backend Workflow Element implementation. 100 * 101 * @return Returns the value of the "java-class" property. 102 */ 103 String getJavaClass(); 104 105 }