Class PathBasedExtensionAvailability
- java.lang.Object
-
- jetbrains.buildServer.web.openapi.PathBasedExtensionAvailability
-
- All Implemented Interfaces:
ExtensionAvailability
public class PathBasedExtensionAvailability extends java.lang.Object implements ExtensionAvailability
- Since:
- 8.1
- Author:
- Maxim Podkolzine (maxim.podkolzine@jetbrains.com)
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
INCLUDE_REQUEST_URI_ATTR
-
Constructor Summary
Constructors Constructor Description PathBasedExtensionAvailability(java.lang.String path)
Constructor.PathBasedExtensionAvailability(java.lang.String... paths)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.String
getPathFromRequest(javax.servlet.http.HttpServletRequest request)
boolean
isAvailable(javax.servlet.http.HttpServletRequest request)
Return whether an extension is available for the specifiedrequest
, i.e.
-
-
-
Field Detail
-
INCLUDE_REQUEST_URI_ATTR
public static final java.lang.String INCLUDE_REQUEST_URI_ATTR
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PathBasedExtensionAvailability
public PathBasedExtensionAvailability(@NotNull java.lang.String path)
Constructor.- Parameters:
path
- place identifier
-
PathBasedExtensionAvailability
public PathBasedExtensionAvailability(@NotNull java.lang.String... paths)
Constructor.- Parameters:
paths
- paths corresponding to this place identifier
-
-
Method Detail
-
isAvailable
public boolean isAvailable(@NotNull javax.servlet.http.HttpServletRequest request)
Description copied from interface:ExtensionAvailability
Return whether an extension is available for the specifiedrequest
, i.e. can be shown. Note that if the result istrue
, extension will be included into a page, but it may still be empty or completely hidden. If the result isfalse
, extension is ignored- Specified by:
isAvailable
in interfaceExtensionAvailability
- Parameters:
request
- the HTTP request- Returns:
- true iff an extension is available
-
getPathFromRequest
@NotNull public static java.lang.String getPathFromRequest(@NotNull javax.servlet.http.HttpServletRequest request)
-
-