Package org.comroid.restless.endpoint
Interface AccessibleEndpoint
-
- All Superinterfaces:
java.util.function.Predicate<java.lang.String>,RatelimitedEndpoint
- All Known Subinterfaces:
ServerEndpoint
public interface AccessibleEndpoint extends RatelimitedEndpoint, java.util.function.Predicate<java.lang.String>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ServerEndpointattachHandler(EndpointHandler handler)default java.util.regex.PatternbuildUrlPattern()default CompleteEndpointcomplete(java.lang.Object... args)default java.lang.String[]extractArgs(java.lang.String requestUrl)default java.lang.String[]extractArgs(java.net.URI uri)default java.lang.String[]extractArgs(java.net.URL url)default java.lang.StringgetFullUrl()default intgetGlobalRatelimit()default intgetParameterCount()default java.util.regex.PatterngetPattern()default intgetRatePerSecond()java.lang.String[]getRegExpGroups()java.lang.StringgetUrlBase()java.lang.StringgetUrlExtension()default java.lang.Stringreplacer(java.lang.String[] groups)default java.lang.Stringstring(java.lang.Object... args)default booleantest(java.lang.String url)default booleantest(java.net.URI uri)default booleantest(java.net.URL url)default java.net.URIuri(java.lang.Object... args)default java.net.URLurl(java.lang.Object... args)
-
-
-
Method Detail
-
getUrlBase
java.lang.String getUrlBase()
-
getUrlExtension
java.lang.String getUrlExtension()
-
getRegExpGroups
java.lang.String[] getRegExpGroups()
-
getPattern
default java.util.regex.Pattern getPattern()
-
getParameterCount
default int getParameterCount()
-
getFullUrl
default java.lang.String getFullUrl()
- Returns:
- The complete, unformatted URL.
-
getRatePerSecond
default int getRatePerSecond()
- Specified by:
getRatePerSecondin interfaceRatelimitedEndpoint- Returns:
- The rate of how often this endpoint can be accessed per second.
Equals
-1, if there is no ratelimit on this endpoint.
-
getGlobalRatelimit
default int getGlobalRatelimit()
- Specified by:
getGlobalRatelimitin interfaceRatelimitedEndpoint- Returns:
- The global ratelimit of all endpoints in this pool.
Equals
-1, if there is no global ratelimit.
-
complete
default CompleteEndpoint complete(java.lang.Object... args) throws java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalArgumentException
-
string
default java.lang.String string(java.lang.Object... args) throws java.lang.IllegalArgumentException- Throws:
java.lang.IllegalArgumentException
-
url
default java.net.URL url(java.lang.Object... args) throws java.lang.IllegalArgumentException- Throws:
java.lang.IllegalArgumentException
-
uri
default java.net.URI uri(java.lang.Object... args) throws java.lang.IllegalArgumentException- Throws:
java.lang.IllegalArgumentException
-
test
default boolean test(java.net.URL url)
-
test
default boolean test(java.net.URI uri)
-
test
default boolean test(java.lang.String url)
- Specified by:
testin interfacejava.util.function.Predicate<java.lang.String>
-
extractArgs
default java.lang.String[] extractArgs(java.net.URL url)
-
extractArgs
default java.lang.String[] extractArgs(java.net.URI uri)
-
extractArgs
default java.lang.String[] extractArgs(java.lang.String requestUrl)
-
replacer
@Internal default java.lang.String replacer(java.lang.String[] groups)
-
buildUrlPattern
default java.util.regex.Pattern buildUrlPattern()
-
attachHandler
default ServerEndpoint attachHandler(EndpointHandler handler)
-
-