RepositoryConfigAO.java

//
// Copyright 2010 Cinch Logic Pty Ltd.
//
// http://www.chililog.com
//
// 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.chililog.server.workbench.workers;

import java.util.ArrayList;

import org.chililog.server.common.ChiliLogException;
import org.chililog.server.data.RepositoryConfigBO;
import org.chililog.server.data.RepositoryParserConfigBO;
import org.chililog.server.data.RepositoryConfigBO.MaxMemoryPolicy;
import org.chililog.server.data.RepositoryConfigBO.Status;
import org.chililog.server.data.UserBO;

/**
 * <p>
 * Repository Config API object is used as part of the {@link RepositoryConfigWorker} service.
 * </p>
 * 
 * @author vibul
 * 
 */
public class RepositoryConfigAO extends AO {

    private String _documentID;
    private Long _documentVersion;
    private String _name;
    private String _displayName;
    private String _description;
    private Status _startupStatus = Status.ONLINE;

    private boolean _storeEntriesIndicator = false;
    private boolean _storageQueueDurableIndicator = false;
    private long _storageQueueWorkerCount = 1;
    private long _storageMaxKeywords = -1;

    private long _maxMemory = 1024 * 1024 * 20; // 20 MB
    private MaxMemoryPolicy _maxMemoryPolicy = MaxMemoryPolicy.PAGE;
    private long _pageSize = 1024 * 1024 * 10; // 10 MB
    private long _pageCountCache = 3; // max 3 pages in memory when paging

    private RepositoryParserConfigAO[] _parsers = null;

    private String[] _users = null;

    /**
     * Basic constructor
     */
    public RepositoryConfigAO() {
        return;
    }

    /**
     * Constructor that copies properties form the business object
     * 
     * @param repoConfig
     *            Repository info business object
     * @param users
     *            Users list of users to check if they have access to this repository
     */
    public RepositoryConfigAO(RepositoryConfigBO repoConfig, UserBO[] users) {
        _documentID = repoConfig.getDocumentID().toString();
        _documentVersion = repoConfig.getDocumentVersion();
        _name = repoConfig.getName();
        _displayName = repoConfig.getDisplayName();
        _description = repoConfig.getDescription();

        _startupStatus = repoConfig.getStartupStatus();

        _storeEntriesIndicator = repoConfig.getStoreEntriesIndicator();
        _storageQueueDurableIndicator = repoConfig.getStorageQueueDurableIndicator();
        _storageQueueWorkerCount = repoConfig.getStorageQueueWorkerCount();
        _storageMaxKeywords = repoConfig.getStorageMaxKeywords();

        _maxMemory = repoConfig.getMaxMemory();
        _maxMemoryPolicy = repoConfig.getMaxMemoryPolicy();
        _pageSize = repoConfig.getPageSize();
        _pageCountCache = repoConfig.getPageCountCache();

        if (repoConfig.getParsers() == null || repoConfig.getParsers().isEmpty()) {
            _parsers = null;
        } else {
            ArrayList<RepositoryParserConfigAO> parserList = new ArrayList<RepositoryParserConfigAO>();
            for (RepositoryParserConfigBO parserInfo : repoConfig.getParsers()) {
                parserList.add(new RepositoryParserConfigAO(parserInfo));
            }
            _parsers = parserList.toArray(new RepositoryParserConfigAO[] {});
        }

        if (users != null) {
            String publisherRole = repoConfig.getPublisherRoleName();
            String subscriberRole = repoConfig.getSubscriberRoleName();
            String workbenchRole = repoConfig.getWorkbenchRoleName();
            ArrayList<String> userList = new ArrayList<String>();
            for (UserBO user : users) {
                if (user.isSystemAdministrator()) {
                    userList.add(String.format("%s=%s", user.getUsername(), UserBO.SYSTEM_ADMINISTRATOR_ROLE_NAME));
                } else {
                    String[] roles = user.getRoles();
                    for (String role : roles) {
                        if (publisherRole.equals(role) || subscriberRole.equals(role) || workbenchRole.equals(role)) {
                            userList.add(String.format("%s=%s", user.getUsername(), role));
                        }
                    }
                }
            }
            _users = userList.toArray(new String[] {});
        }

        return;
    }

    /**
     * Updates the supplied business object with info from this api object
     * 
     * @param repoInfo
     *            business object to update
     * @throws ChiliLogException
     */
    public void toBO(RepositoryConfigBO repoInfo) throws ChiliLogException {
        checkOptimisticLocking(_documentVersion, repoInfo);

        repoInfo.setName(_name);
        repoInfo.setDisplayName(_displayName);
        repoInfo.setDescription(_description);
        repoInfo.setStartupStatus(_startupStatus);

        repoInfo.setStoreEntriesIndicator(_storeEntriesIndicator);
        repoInfo.setStorageQueueDurableIndicator(_storageQueueDurableIndicator);
        repoInfo.setStorageQueueWorkerCount(_storageQueueWorkerCount);
        repoInfo.setStorageMaxKeywords(_storageMaxKeywords);

        repoInfo.setMaxMemory(_maxMemory);
        repoInfo.setMaxMemoryPolicy(_maxMemoryPolicy);
        repoInfo.setPageSize(_pageSize);
        repoInfo.setPageCountCache(_pageCountCache);

        repoInfo.getParsers().clear();
        if (_parsers != null && _parsers.length > 0) {
            for (RepositoryParserConfigAO parserInfo : _parsers) {
                RepositoryParserConfigBO bo = new RepositoryParserConfigBO();
                parserInfo.toBO(bo);
                repoInfo.getParsers().add(bo);
            }
        }

        return;
    }

    public String getDocumentID() {
        return _documentID;
    }

    public void setDocumentID(String documentID) {
        _documentID = documentID;
    }

    public Long getDocumentVersion() {
        return _documentVersion;
    }

    public void setDocumentVersion(Long documentVersion) {
        _documentVersion = documentVersion;
    }

    public String getName() {
        return _name;
    }

    public void setName(String name) {
        _name = name;
    }

    public String getDisplayName() {
        return _displayName;
    }

    public void setDisplayName(String displayName) {
        _displayName = displayName;
    }

    public String getDescription() {
        return _description;
    }

    public void setDescription(String description) {
        _description = description;
    }

    public Status getStartupStatus() {
        return _startupStatus;
    }

    public void setStartupStatus(Status startupStatus) {
        _startupStatus = startupStatus;
    }

    public boolean getStoreEntriesIndicator() {
        return _storeEntriesIndicator;
    }

    public void setStoreEntriesIndicator(boolean storeEntriesIndicator) {
        _storeEntriesIndicator = storeEntriesIndicator;
    }

    public boolean getStorageQueueDurableIndicator() {
        return _storageQueueDurableIndicator;
    }

    public void setStorageQueueDurableIndicator(boolean storageQueueDurableIndicator) {
        _storageQueueDurableIndicator = storageQueueDurableIndicator;
    }

    public long getStorageQueueWorkerCount() {
        return _storageQueueWorkerCount;
    }

    public void setStorageQueueWorkerCount(long storageQueueWorkerCount) {
        _storageQueueWorkerCount = storageQueueWorkerCount;
    }

    public long getStorageMaxKeywords() {
        return _storageMaxKeywords;
    }

    public void setStorageMaxKeywords(long maxKeywords) {
        _storageMaxKeywords = maxKeywords;
    }

    public long getMaxMemory() {
        return _maxMemory;
    }

    public void setMaxMemory(long maxMemory) {
        _maxMemory = maxMemory;
    }

    public MaxMemoryPolicy getMaxMemoryPolicy() {
        return _maxMemoryPolicy;
    }

    public void setMaxMemoryPolicy(MaxMemoryPolicy maxMemoryPolicy) {
        _maxMemoryPolicy = maxMemoryPolicy;
    }

    public long getPageSize() {
        return _pageSize;
    }

    public void setPageSize(long pageSize) {
        _pageSize = pageSize;
    }

    public long getPageCountCache() {
        return _pageCountCache;
    }

    public void setPageCountCache(long pageCountCache) {
        _pageCountCache = pageCountCache;
    }

    public RepositoryParserConfigAO[] getParsers() {
        return _parsers;
    }

    public void setParsers(RepositoryParserConfigAO[] parsers) {
        _parsers = parsers;
    }

    /**
     * Returns the users who can access this repository in the format username=role
     */
    public String[] getUsers() {
        return _users;
    }

    public void setUsers(String[] users) {
        _users = users;
    }

}