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.surf.resource;
20
21 /**
22 * Interface for web framework resource loader factories.
23 *
24 * @author muzquiano
25 */
26 public interface ResourceLoaderFactory
27 {
28 /**
29 * Returns a resource loader that is bound to the given
30 * endpoint.
31 *
32 * @param protocolId the protocol id
33 * @param endpointId the endpoint id
34 *
35 * @return the resource loader
36 */
37 public ResourceLoader getResourceLoader(String protocolId, String endpointId);
38
39 /**
40 * Returns the order of preference for this resource loader
41 *
42 * @return order
43 */
44 public int getOrder();
45
46 /**
47 * Identifies whether this factory can produce resource
48 * loaders that can handle the given protocol
49 *
50 * @param protocolId
51 *
52 * @return whether this factory can produce for the given protocol
53 */
54 public boolean canHandle(String protocolId);
55 }