CST.java

/**
 * Copyright 2011-2012 Universite Joseph Fourier, LIG, ADELE team
 *   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 fr.imag.adele.apam;

import java.net.URL;
import java.util.HashMap;
import java.util.Map;

import fr.imag.adele.apam.impl.APAMImpl;
import fr.imag.adele.apam.impl.ApamResolverImpl;
import fr.imag.adele.apam.impl.ComponentBrokerImpl;

public class CST {

	// Values are boolean
	public static final String INSTANTIABLE = "instantiable";
	// multiple on a relation indicates more than one outgoing wire
	public static final String MULTIPLE = "multiple";
	// remotable indicates that the instance can be used from a remote machine
	public static final String REMOTABLE = "remotable";
	// shared indicates if its instances can have more than one incoming wire
	public static final String SHARED = "shared";
	// a single instance per implementation
	public static final String SINGLETON = "singleton";

	// // APAM ROOT COMPOSITE
	public static final String ROOT_COMPOSITE_TYPE = "root";

	// Constant used by OBR
	// Capability
	public static final String MAVEN = "maven";
	public static final String GROUP_ID = "groupId";
	public static final String ARTIFACT_ID = "artifactId";

	public static final String CAPABILITY_COMPONENT = "apam-component";
	public static final String COMPONENT_TYPE = "component-type";
	public static final String SPECIFICATION = "specification";
	public static final String IMPLEMENTATION = "implementation";
	public static final String INSTANCE = "instance";
	public static final String APAM_PREFIX = "apam-";
	public static final String DEFINITION_PREFIX = "definition-";
    public static final String RELATION_PREFIX = "relation-";
	public static final String PROVIDE_PREFIX = "provide-";
	public static final String REQUIRE_PREFIX = "require-";
	public static final String REQUIRE_INTERFACE = "require-interface";
	public static final String REQUIRE_SPECIFICATION = "require-specification";
	public static final String REQUIRE_MESSAGE = "require-message";
    public static final String REQUIRE_VERSION = "require-version";
	public static final String PROVIDE_INTERFACES = "provide-interfaces";
	public static final String PROVIDE_MESSAGES = "provide-messages";
    public static final String PROVIDE_CLASSNAME = "provide-classname";

	public static final String PROVIDE_SPECIFICATION = "provide-specification";

	public static final String NAME = "name";
	public static final String VERSION = "version";
	public static final String SPECNAME = "spec-name";
	public static final String IMPLNAME = "impl-name";
	public static final String INSTNAME = "inst-name";
	public static final String INTERFACE = "interface";
	public static final String MESSAGE = "message";
	public static final String APAM_MAIN_COMPONENT = "apam-main-component";
	public static final String APAM_MAIN_INSTANCE = "apam-main-instance";
	public static final String APAM_COMPOSITE = "apam-composite";
	public static final String APAM_COMPOSITETYPE = "apam-compositetype";

	// These prefix cannot be used by users because they would conflict in the
	// OBR.
	public static final String[] reservedPrefix = { CST.APAM_PREFIX, CST.DEFINITION_PREFIX, CST.PROVIDE_PREFIX, CST.REQUIRE_PREFIX, CST.RELATION_PREFIX };

	public static final String[] notInheritedAttribute = { NAME, COMPONENT_TYPE, VERSION, APAM_COMPOSITETYPE };

	// Attributes that cannot be changed nor set by users
	public static final String[] finalAttributes = { CST.NAME, CST.COMPONENT_TYPE, CST.SPECNAME, CST.IMPLNAME, CST.INSTNAME, CST.MESSAGE, CST.APAM_COMPOSITE, CST.APAM_COMPOSITETYPE, CST.APAM_MAIN_COMPONENT, CST.APAM_MAIN_INSTANCE, CST.INTERFACE, CST.REQUIRE_INTERFACE, CST.REQUIRE_SPECIFICATION, CST.REQUIRE_MESSAGE, CST.PROVIDE_INTERFACES, CST.PROVIDE_MESSAGES, CST.PROVIDE_SPECIFICATION, CST.PROVIDE_CLASSNAME, CST.INSTANTIABLE, CST.MULTIPLE, CST.REMOTABLE, CST.SHARED, CST.SINGLETON, CST.REQUIRE_VERSION };

	// Attributes set during the build that cannot be changed nor set by users
	public static final String[] buildAttributes = { CST.buildMavenGroupId, CST.buildMavenArtifactId, CST.buildMavenVersion, CST.buildApamVersion, CST.buildVersion};
	
	public static final String buildAttributePrefix = "build.";
	public static final String buildMavenGroupId = "maven.groupId";
	public static final String buildMavenArtifactId = "maven.artifactId";
	public static final String buildMavenVersion = "maven.version";
	public static final String buildApamVersion = "apam.version";
	public static final String buildVersion = "version";
	

	public static final String V_TRUE = "true";
	public static final String V_FALSE = "false";

	// Relations that cannot be changed nor set by users
	// public static final String REL_GROUP = "group";
	// public static final String REL_MEMBERS = "members";
	public static final String REL_CONTAINS = "contains";
	public static final String REL_COMPOSITE = "composite";
	public static final String REL_COMPOTYPE = "compotype";
	public static final String REL_APPLI = "appli";
	public static final String REL_SPEC = "spec";
	public static final String REL_IMPL = "impl";
	public static final String REL_INST = "inst";
	public static final String REL_IMPLS = "impls";
	public static final String REL_INSTS = "insts";

	public static final String[] finalRelations = { REL_CONTAINS, REL_COMPOSITE, REL_APPLI, REL_COMPOTYPE, REL_SPEC, REL_IMPL, REL_INST, REL_IMPLS, REL_INSTS };

	// Internal Managers
	public static final String APAMMAN 		= "APAMMAN";
	public static final String DYNAMAN 		= "DYNAMAN";
	public static final String UPDATEMAN 	= "UPDATEMAN";

	// The entry point in the ASM : its broker
	public static ComponentBroker componentBroker = null;

	public static ApamResolver apamResolver = null;
	// the Apam entry point.
	public static Apam apam = null;

	
	// The root composite configuration
	public static final Map<String,URL> rootConfiguration = new HashMap<String,URL>();
	
	public static boolean isFinalRelation(String attr) {
		for (String pred : CST.finalRelations) {
			if (pred.equals(attr)) {
				return true;
			}
		}
		return false;
	}

	public CST(APAMImpl theApam, Map<String,URL> configuration) {
		CST.apam 			= theApam;
		CST.componentBroker = new ComponentBrokerImpl();
		CST.apamResolver 	= new ApamResolverImpl(theApam);
		
		CST.rootConfiguration.putAll(configuration);

	}

}