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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.meta;
027
028
029
030import org.opends.server.admin.AdministratorAction;
031import org.opends.server.admin.BooleanPropertyDefinition;
032import org.opends.server.admin.ClassPropertyDefinition;
033import org.opends.server.admin.client.AuthorizationException;
034import org.opends.server.admin.client.CommunicationException;
035import org.opends.server.admin.client.ConcurrentModificationException;
036import org.opends.server.admin.client.ManagedObject;
037import org.opends.server.admin.client.MissingMandatoryPropertiesException;
038import org.opends.server.admin.client.OperationRejectedException;
039import org.opends.server.admin.DefaultBehaviorProvider;
040import org.opends.server.admin.DefinedDefaultBehaviorProvider;
041import org.opends.server.admin.ManagedObjectAlreadyExistsException;
042import org.opends.server.admin.ManagedObjectDefinition;
043import org.opends.server.admin.PropertyOption;
044import org.opends.server.admin.PropertyProvider;
045import org.opends.server.admin.server.ConfigurationChangeListener;
046import org.opends.server.admin.server.ServerManagedObject;
047import org.opends.server.admin.std.client.HTTPAccessLogPublisherCfgClient;
048import org.opends.server.admin.std.server.HTTPAccessLogPublisherCfg;
049import org.opends.server.admin.std.server.LogPublisherCfg;
050import org.opends.server.admin.Tag;
051import org.opends.server.types.DN;
052
053
054
055/**
056 * An interface for querying the HTTP Access Log Publisher managed
057 * object definition meta information.
058 * <p>
059 * HTTP Access Log Publishers are responsible for distributing HTTP
060 * access log messages from the HTTP access logger to a destination.
061 */
062public final class HTTPAccessLogPublisherCfgDefn extends ManagedObjectDefinition<HTTPAccessLogPublisherCfgClient, HTTPAccessLogPublisherCfg> {
063
064  // The singleton configuration definition instance.
065  private static final HTTPAccessLogPublisherCfgDefn INSTANCE = new HTTPAccessLogPublisherCfgDefn();
066
067
068
069  // The "java-class" property definition.
070  private static final ClassPropertyDefinition PD_JAVA_CLASS;
071
072
073
074  // Build the "java-class" property definition.
075  static {
076      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
077      builder.setOption(PropertyOption.MANDATORY);
078      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class"));
079      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.loggers.HTTPAccessLogPublisher");
080      builder.setDefaultBehaviorProvider(provider);
081      builder.addInstanceOf("org.opends.server.loggers.LogPublisher");
082      PD_JAVA_CLASS = builder.getInstance();
083      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
084  }
085
086
087
088  // Register the tags associated with this managed object definition.
089  static {
090    INSTANCE.registerTag(Tag.valueOf("logging"));
091  }
092
093
094
095  /**
096   * Get the HTTP Access Log Publisher configuration definition
097   * singleton.
098   *
099   * @return Returns the HTTP Access Log Publisher configuration
100   *         definition singleton.
101   */
102  public static HTTPAccessLogPublisherCfgDefn getInstance() {
103    return INSTANCE;
104  }
105
106
107
108  /**
109   * Private constructor.
110   */
111  private HTTPAccessLogPublisherCfgDefn() {
112    super("http-access-log-publisher", LogPublisherCfgDefn.getInstance());
113  }
114
115
116
117  /**
118   * {@inheritDoc}
119   */
120  public HTTPAccessLogPublisherCfgClient createClientConfiguration(
121      ManagedObject<? extends HTTPAccessLogPublisherCfgClient> impl) {
122    return new HTTPAccessLogPublisherCfgClientImpl(impl);
123  }
124
125
126
127  /**
128   * {@inheritDoc}
129   */
130  public HTTPAccessLogPublisherCfg createServerConfiguration(
131      ServerManagedObject<? extends HTTPAccessLogPublisherCfg> impl) {
132    return new HTTPAccessLogPublisherCfgServerImpl(impl);
133  }
134
135
136
137  /**
138   * {@inheritDoc}
139   */
140  public Class<HTTPAccessLogPublisherCfg> getServerConfigurationClass() {
141    return HTTPAccessLogPublisherCfg.class;
142  }
143
144
145
146  /**
147   * Get the "enabled" property definition.
148   * <p>
149   * Indicates whether the HTTP Access Log Publisher is enabled for
150   * use.
151   *
152   * @return Returns the "enabled" property definition.
153   */
154  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
155    return LogPublisherCfgDefn.getInstance().getEnabledPropertyDefinition();
156  }
157
158
159
160  /**
161   * Get the "java-class" property definition.
162   * <p>
163   * The fully-qualified name of the Java class that provides the HTTP
164   * Access Log Publisher implementation.
165   *
166   * @return Returns the "java-class" property definition.
167   */
168  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
169    return PD_JAVA_CLASS;
170  }
171
172
173
174  /**
175   * Managed object client implementation.
176   */
177  private static class HTTPAccessLogPublisherCfgClientImpl implements
178    HTTPAccessLogPublisherCfgClient {
179
180    // Private implementation.
181    private ManagedObject<? extends HTTPAccessLogPublisherCfgClient> impl;
182
183
184
185    // Private constructor.
186    private HTTPAccessLogPublisherCfgClientImpl(
187        ManagedObject<? extends HTTPAccessLogPublisherCfgClient> impl) {
188      this.impl = impl;
189    }
190
191
192
193    /**
194     * {@inheritDoc}
195     */
196    public Boolean isEnabled() {
197      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
198    }
199
200
201
202    /**
203     * {@inheritDoc}
204     */
205    public void setEnabled(boolean value) {
206      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
207    }
208
209
210
211    /**
212     * {@inheritDoc}
213     */
214    public String getJavaClass() {
215      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
216    }
217
218
219
220    /**
221     * {@inheritDoc}
222     */
223    public void setJavaClass(String value) {
224      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
225    }
226
227
228
229    /**
230     * {@inheritDoc}
231     */
232    public ManagedObjectDefinition<? extends HTTPAccessLogPublisherCfgClient, ? extends HTTPAccessLogPublisherCfg> definition() {
233      return INSTANCE;
234    }
235
236
237
238    /**
239     * {@inheritDoc}
240     */
241    public PropertyProvider properties() {
242      return impl;
243    }
244
245
246
247    /**
248     * {@inheritDoc}
249     */
250    public void commit() throws ManagedObjectAlreadyExistsException,
251        MissingMandatoryPropertiesException, ConcurrentModificationException,
252        OperationRejectedException, AuthorizationException,
253        CommunicationException {
254      impl.commit();
255    }
256
257
258
259    /** {@inheritDoc} */
260    public String toString() {
261      return impl.toString();
262    }
263  }
264
265
266
267  /**
268   * Managed object server implementation.
269   */
270  private static class HTTPAccessLogPublisherCfgServerImpl implements
271    HTTPAccessLogPublisherCfg {
272
273    // Private implementation.
274    private ServerManagedObject<? extends HTTPAccessLogPublisherCfg> impl;
275
276    // The value of the "enabled" property.
277    private final boolean pEnabled;
278
279    // The value of the "java-class" property.
280    private final String pJavaClass;
281
282
283
284    // Private constructor.
285    private HTTPAccessLogPublisherCfgServerImpl(ServerManagedObject<? extends HTTPAccessLogPublisherCfg> impl) {
286      this.impl = impl;
287      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
288      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
289    }
290
291
292
293    /**
294     * {@inheritDoc}
295     */
296    public void addHTTPAccessChangeListener(
297        ConfigurationChangeListener<HTTPAccessLogPublisherCfg> listener) {
298      impl.registerChangeListener(listener);
299    }
300
301
302
303    /**
304     * {@inheritDoc}
305     */
306    public void removeHTTPAccessChangeListener(
307        ConfigurationChangeListener<HTTPAccessLogPublisherCfg> listener) {
308      impl.deregisterChangeListener(listener);
309    }
310    /**
311     * {@inheritDoc}
312     */
313    public void addChangeListener(
314        ConfigurationChangeListener<LogPublisherCfg> listener) {
315      impl.registerChangeListener(listener);
316    }
317
318
319
320    /**
321     * {@inheritDoc}
322     */
323    public void removeChangeListener(
324        ConfigurationChangeListener<LogPublisherCfg> listener) {
325      impl.deregisterChangeListener(listener);
326    }
327
328
329
330    /**
331     * {@inheritDoc}
332     */
333    public boolean isEnabled() {
334      return pEnabled;
335    }
336
337
338
339    /**
340     * {@inheritDoc}
341     */
342    public String getJavaClass() {
343      return pJavaClass;
344    }
345
346
347
348    /**
349     * {@inheritDoc}
350     */
351    public Class<? extends HTTPAccessLogPublisherCfg> configurationClass() {
352      return HTTPAccessLogPublisherCfg.class;
353    }
354
355
356
357    /**
358     * {@inheritDoc}
359     */
360    public DN dn() {
361      return impl.getDN();
362    }
363
364
365
366    /** {@inheritDoc} */
367    public String toString() {
368      return impl.toString();
369    }
370  }
371}