1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts.connector;
20
21 import org.springframework.extensions.surf.exception.ConnectorProviderException;
22
23 /**
24 * Contract to be implemented by any object that can provide a Connector to another object.
25 * <p>
26 * Connectors are quite expensive to instantiate and obtain. Therefore this contract is
27 * generally used where you want to lazily provide a connector in a situation where it is
28 * not know if a connector is actually required (maybe due to caching etc.) until runtime.
29 *
30 * @author Kevin Roast
31 */
32 public interface ConnectorProvider
33 {
34 /**
35 * Builds a Connector object mounted against the given endpoint
36 *
37 * @param endpoint
38 *
39 * @return the connector object
40 */
41 public Connector provide(String endpoint) throws ConnectorProviderException;
42 }