01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19: package org.apache.axis2.dataretrieval;
20:
21: import org.apache.axis2.context.MessageContext;
22:
23: /**
24: * <p>AxisDataLocator interface defines getData API for retrieving data particularly
25: * metadata like WSDL, Policy, Schema. Web Service engines that have different methods in
26: * storing metadata or different types of data to retrieve may code their version of
27: * Data Locator(s)by implementing the AxisDataLocator interface. Axis 2 support
28: * Data Locator plugin by configuring in Axis2.xml or services.xml. </p>
29: */
30:
31: public interface AxisDataLocator {
32:
33: /**
34: * Retrieves and returns data based on the specified request.
35: *
36: * @param request The {@link DataRetrievalRequest} allow to specify parameters
37: * about the request, and additional information to process the
38: * request.
39: * @param msgContext The {@link MessageContext} from the original request.
40: * @return {@link Data}[] for the request.
41: * @throws DataRetrievalException
42: */
43:
44: public Data[] getData(DataRetrievalRequest request,
45: MessageContext msgContext) throws DataRetrievalException;
46:
47: }
|