001/*
002 * (C) Copyright 2006-2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Thierry Delprat
018 */
019package org.nuxeo.ecm.platform.audit.service.extension;
020
021import java.io.Serializable;
022
023import org.apache.commons.lang3.StringUtils;
024import org.nuxeo.common.xmap.annotation.XNode;
025import org.nuxeo.common.xmap.annotation.XObject;
026import org.nuxeo.ecm.platform.audit.service.AuditBackend;
027import org.nuxeo.ecm.platform.audit.service.DefaultAuditBackend;
028import org.nuxeo.ecm.platform.audit.service.NXAuditEventsService;
029import org.nuxeo.runtime.api.Framework;
030import org.nuxeo.runtime.model.DefaultComponent;
031
032/**
033 * Descriptor to configure / contribute a Backend for Audit service
034 *
035 * @author tiry
036 */
037@XObject("backend")
038public class AuditBackendDescriptor implements Serializable {
039
040    private static final long serialVersionUID = 1L;
041
042    @XNode("@class")
043    protected Class<? extends AuditBackend> klass = DefaultAuditBackend.class;
044
045    @XNode("require")
046    String requiredComponent;
047
048    public int getApplicationStartedOrder() {
049        if (StringUtils.isEmpty(requiredComponent)) {
050            return 1000;
051        }
052        return ((DefaultComponent)Framework.getRuntime().getComponent(requiredComponent)).getApplicationStartedOrder()+1;
053    }
054
055    public Class<? extends AuditBackend> getKlass() {
056        return klass;
057    }
058
059    public AuditBackend newInstance(NXAuditEventsService component) {
060        try {
061            return klass.getDeclaredConstructor(NXAuditEventsService.class, AuditBackendDescriptor.class).newInstance(component, this);
062        } catch (ReflectiveOperationException cause) {
063            throw new RuntimeException("Cannot create audit backend of type " + klass.getName(), cause);
064        }
065    }
066
067}