-
Notifications
You must be signed in to change notification settings - Fork 732
/
UrlProcessor.java
57 lines (51 loc) · 2 KB
/
UrlProcessor.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright 2019 Adobe
~
~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
package com.adobe.cq.wcm.core.components.services.embed;
import java.util.Map;
/**
* Interface that defines a generic processor for a given URL.
*
* @since com.adobe.cq.wcm.core.components.services.embed 1.0.0
*/
public interface UrlProcessor {
/**
* Returns the result of processing the given URL, {@code null} if processing is not possible or failed.
*
* @param url The URL to process
* @return The {@link Result} of processing, {@code null} if processing is not possible or failed.
* @since com.adobe.cq.wcm.core.components.services.embed 1.0.0
*/
Result process(String url);
/**
* @since com.adobe.cq.wcm.core.components.services.embed 1.0.0
*/
interface Result {
/**
* Returns the name of the processor that was able to process the URL.
*
* @return Name of the processor.
* @since com.adobe.cq.wcm.core.components.services.embed 1.0.0
*/
String getProcessor();
/**
* Returns the data from the processor that was able to process the URL.
*
* @return Data from the processor that was able to process the URL.
* @since com.adobe.cq.wcm.core.components.services.embed 1.0.0
*/
Map<String, Object> getOptions();
}
}