FilterConfig.java

// ---------------------------------------------------------------------------
// jWebSocket - Copyright (c) 2010 jwebsocket.org
// ---------------------------------------------------------------------------
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by the
// Free Software Foundation; either version 3 of the License, or (at your
// option) any later version.
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
// more details.
// You should have received a copy of the GNU Lesser General Public License along
// with this program; if not, see <http://www.gnu.org/licenses/lgpl.html>.
// ---------------------------------------------------------------------------
package org.jwebsocket.config.xml;

import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.jwebsocket.api.FilterConfiguration;
import org.jwebsocket.config.Config;
import org.jwebsocket.kit.WebSocketRuntimeException;

/**
 * Class that represents the filter config
 * @author puran
 * @version $Id: FilterConfig.java 596 2010-06-22 17:09:54Z fivefeetfurther $
 * 
 */
public final class FilterConfig implements Config, FilterConfiguration {
	private final String id;
	private final String name;
	private final String jar;
	private final String packageName;
	private final String namespace;
	private final List<String> servers;
	private final Map<String, String> settings;

	/**
	 * default constructor
	 * @param id the plugin id
	 * @param name the plugin name
	 * @param jar the plugin jar
	 * @param namespace the namespace 
	 * @param settings map of settings key and value
	 */
	public FilterConfig(String id, String name, String packageName, String jar, String namespace,
		 List<String> servers, Map<String, String> settings) {
		this.id = id;
		this.name = name;
		this.packageName = packageName;
		this.jar = jar;
		this.namespace = namespace;
		this.servers = servers;
		this.settings = settings;
		validate();
	}

	/**
	 * @return the id
	 */
	public String getId() {
		return id;
	}

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}
	/**
	 * @return the package 
	 */
	public String getPackage() {
		return packageName;
	}

	/**
	 * @return the jar
	 */
	public String getJar() {
		return jar;
	}

	/**
	 * @return the namespace
	 */
	public String getNamespace() {
		return namespace;
	}
	
	/**
	 * @return the list of servers
	 */
	public List<String> getServers() {
		return Collections.unmodifiableList(servers);
	}
	/**
	 * @return the settings
	 */
	public Map<String, String> getSettings() {
		return Collections.unmodifiableMap(settings);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void validate() {
		if ((id != null && id.length() > 0)
				&& (name != null && name.length() > 0)
				&& (jar != null && jar.length() > 0)
				&& (namespace != null && namespace.length() > 0)) {
			return;
		}
		throw new WebSocketRuntimeException(
				"Missing one of the filter configuration, please check your configuration file");
	}

  @Override
  public String getPackageName() {
    return packageName;
  }

}