org.apache.woden.wsdl20.extensions.ComponentExtensionContext Maven / Gradle / Ivy

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.woden.wsdl20.extensions;

import java.net.URI;

import org.apache.woden.wsdl20.WSDLComponent;

/**
 * This interface defines a generic API for accessing the extension properties
 * from a particular extension namespace that are attached to a particular 
 * WSDL 2.0 component. That is, for accessing extension properties by namespace
 * per component.
 * 
 * It provides accessor methods that return ExtensionProperty objects, 
 * which callers can use to access the content of an extension property.
 * 

 * Implementors of WSDL 2.0 extensions must, as a minimum, implement this interface
 * for each WSDL 2.0 component they extend. They must also register their
 * extension implementations using the ExtensionRegistry. 
 * Implementors may optionally extend this interface to add their own extension-specific 
 * property accessor methods to the generic accessor methods declared by this interface.
 * For examples of this, see the SOAP and HTTP binding extensions provided by Woden.
 * 

 * To document extensions consistently, implementors should copy the following Javadoc 
 * fragment to use for their implementation classes or for their sub-interfaces of this
 * interface, replacing the square bracket parts [...] accordingly.
 * 

 * start of fragment:
 * 

 * Provides access to the extension properties of the [parent component name] component 
 * that are in the [extension namespace] namespace.
 * These extension properties can be accessed as ExtensionProperty objects 
 * via the getProperties and getProperty methods  
 * using the property names and Java types shown in the following table.
 * 

 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Property name Java type
[property name] [java type]
... ...
 * 
 * end of fragment:
 * 
 * @author John Kaputin ([email protected])
 * 
 * @see org.apache.woden.wsdl20.extensions.ExtensionProperty
 */
public interface ComponentExtensionContext {

    public WSDLComponent getParent();
    
    public URI getNamespace();

    public ExtensionProperty[] getProperties();
    
    public ExtensionProperty getProperty(String propertyName);
}