ContentNamespace.java

/*
 * #%L
 * Gravia :: Resource
 * %%
 * Copyright (C) 2010 - 2014 JBoss by Red Hat
 * %%
 * 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.
 * #L%
 */
package org.jboss.gravia.resource;



/**
 * Content Capability Namespace.
 *
 * <p>
 * This class defines the names for the attributes and directives for this
 * namespace. All unspecified capability attributes are of type {@code String}
 * and are used as arbitrary matching attributes for the capability. The values
 * associated with the specified directive and attribute keys are of type
 * {@code String}, unless otherwise indicated.
 *
 * @author thomas.diesler@jboss.com
 * @since 05-Jul-2012
 */
public interface ContentNamespace extends Namespace {

	/**
	 * Namespace name for content capabilities and requirements.
	 *
	 * <p>
	 * Also, the capability attribute used to specify the unique identifier of
	 * the content. This identifier is the {@code SHA-256} hash of the content.
	 */
	String	CONTENT_NAMESPACE			= "gravia.content";

	/**
	 * A capability attribute that contains the URL to the content.
	 */
	String	CAPABILITY_URL_ATTRIBUTE	= "url";

    /**
     * A capability attribute that contains an InputStream to the content.
     */
    String  CAPABILITY_STREAM_ATTRIBUTE    = "stream";

	/**
	 * A capability attribute that contains the size, in bytes, of the
	 * content. The value of this attribute must be of type {@code Long}.
	 */
	String	CAPABILITY_SIZE_ATTRIBUTE	= "size";

	/**
	 * A capability attribute that defines the IANA MIME Type/Format for this
	 * content.
	 */
	String	CAPABILITY_MIME_ATTRIBUTE	= "mime";

    /**
     * A capability directive that names the comma separated set of runtime types
     * that this content applies to.
     */
    String  CAPABILITY_INCLUDE_RUNTIME_TYPE_DIRECTIVE   = "include.runtime.type";

    /**
     * A capability directive that names the comma separated set of runtime types
     * that this content does not apply to.
     */
    String  CAPABILITY_EXCLUDE_RUNTIME_TYPE_DIRECTIVE   = "exclude.runtime.type";

    /**
     * Artifact coordinates may be defined by the simple groupId:artifactId:version form,
     * or the fully qualified form groupId:artifactId:type:version[:classifier]
     */
    String CAPABILITY_MAVEN_IDENTITY_ATTRIBUTE = "maven.identity";

    /**
     * The capability attribute defining the runtime name during deployment.
     * The default is the identity symbolic name.
     */
    String CAPABILITY_RUNTIME_NAME_ATTRIBUTE = "runtime.name";
}