org.xipki.audit.Audits Maven / Gradle / Ivy

Go to download
/*
 *
 * Copyright (c) 2013 - 2019 Lijun Liao
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.xipki.audit;

import org.xipki.audit.services.EmbedAuditService;
import org.xipki.audit.services.SyslogAuditService;

/**
 * Helper class to configure and initialize the Audit.
 *
 * @author Lijun Liao
 */

public class Audits {

  public static class AuditConf {

    /**
     * valid values are:
     *   embed: use the embedded slf4j logging
     *   syslog: use the syslog
     *   java:<name of class that implements org.xipki.audit.AuditService>
     */
    private String type;

    private String conf;

    public static AuditConf DEFAULT = new AuditConf();

    public String getType() {
      return type == null || type.isEmpty() ? "embed" : type;
    }

    public void setType(String type) {
      this.type = type;
    }

    public String getConf() {
      return conf;
    }

    public void setConf(String conf) {
      this.conf = conf;
    }

  }

  private static AuditService auditService;

  private static AuditServiceRuntimeException initializationException;

  private Audits() {
  }

  public static AuditService getAuditService() {
    if (auditService != null) {
      return auditService;
    }

    if (initializationException != null) {
      throw initializationException;
    } else {
      throw new IllegalStateException("Please call Audits.init() first.");
    }
  }

  public static void init(String auditType, String auditConf)  {
    try {
      AuditService service;
      if ("embed".equalsIgnoreCase(auditType)) {
        service = new EmbedAuditService();
      } else if ("syslog".equalsIgnoreCase(auditType)) {
        service = new SyslogAuditService();
      } else  if (auditType.startsWith("java:")) {
        String className = auditType.substring("java:".length());
        try {
          Class clazz = Class.forName(className);
          service = (AuditService) clazz.newInstance();
        } catch (ClassCastException | ClassNotFoundException | IllegalAccessException
            | InstantiationException ex) {
          throw new AuditServiceRuntimeException(
              "error caught while initializing AuditService " + auditType
              + ": " + ex.getClass().getName() + ": " + ex.getMessage(), ex);
        }
      } else {
        throw new AuditServiceRuntimeException("invalid Audit.Type '" + auditType
            + "'. Valid values are 'embed', 'syslog' or java:");
      }

      service.init(auditConf);
      auditService = service;
    } catch (AuditServiceRuntimeException ex) {
      initializationException = ex;
    } catch (RuntimeException ex) {
      initializationException = new AuditServiceRuntimeException(ex.getMessage(), ex);
    }
  }

}