Index (parking-access-api-client 2.0.1 API)

A B C D E F G H I J L M N O P Q R S T U V W
All Classes All Packages

A

ACCESS_REQUESTS_URL - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
ACCESS_RIGHTS_URL - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
AccessDirection - Enum in net.commuty.parking.model: When reporting accesses on a parking site, this represents whether a user is coming in (AccessDirection.IN) or existing (AccessDirection.OUT) the parking site.
AccessLog - Class in net.commuty.parking.model: This corresponds to a user that entered or exited a parking site at a point in time.
AccessRight - Class in net.commuty.parking.model: This holds the access right: for a user identified by one or more of its ids; for a specific parking site; for a period of time (starting from AccessRight.getStartTime() until before AccessRight.getEndTime()); whether is access is allowed or not.
ApiException - Exception in net.commuty.parking.http: Any Exception that the client can throw.
ApiException() - Constructor for exception net.commuty.parking.http.ApiException
ApiException(String) - Constructor for exception net.commuty.parking.http.ApiException
ApiException(String, Throwable) - Constructor for exception net.commuty.parking.http.ApiException
ApiException(Throwable) - Constructor for exception net.commuty.parking.http.ApiException
authenticate() - Method in interface net.commuty.parking.ParkingAccess: Retrieve a token based on the username and password you provided at the creation of the Builder.
authenticate() - Method in class net.commuty.parking.rest.ParkingAccessRestClient

B

BADGE_NUMBER - net.commuty.parking.model.UserIdType
build() - Method in class net.commuty.parking.Configuration.Builder: Creates a Configuration instance.
buildDefault(String, String) - Static method in class net.commuty.parking.Configuration.Builder: Creates a new configuration instance using default values (default host and no proxy).

C

CARDHOLDER_ID - net.commuty.parking.model.UserIdType
commuty.parking.access.client - module commuty.parking.access.client
Configuration - Class in net.commuty.parking: This will be your entry point to use the Rest client.
Configuration.Builder - Class in net.commuty.parking: Build a configuration object that will be used ton instantiate a Rest client.
covers(LocalDateTime) - Method in class net.commuty.parking.model.AccessRight: Check if this access right happens in the given moment or not.
create() - Static method in class net.commuty.parking.Configuration.Builder
createInAccessLog(UserId, LocalDateTime) - Static method in class net.commuty.parking.model.AccessLog: Create a report for a user that entered the parking site at the specified time.
createInAccessLog(UserId, LocalDateTime, boolean, String) - Static method in class net.commuty.parking.model.AccessLog: Create a report for a user that entered the parking site at the specified time.
createOutAccessLog(UserId, LocalDateTime) - Static method in class net.commuty.parking.model.AccessLog: Create a report for a user that exited the parking site at the specified time.
createOutAccessLog(UserId, LocalDateTime, boolean, String) - Static method in class net.commuty.parking.model.AccessLog: Create a report for a user that exited the parking site at the specified time.
CredentialsException - Exception in net.commuty.parking.http: If your username or password is invalid, this exception will occur.
CredentialsException() - Constructor for exception net.commuty.parking.http.CredentialsException

D

DAY_PARAM - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient

E

EMAIL - net.commuty.parking.model.UserIdType
Error - Interface in net.commuty.parking.http: This may contain more information when a HttpRequestException occurs.

F

fromBadgeNumber(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a badge number.
fromCardholderId(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a cardholder identifier.
fromEmail(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on an email.
fromIdentificationNumber(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on an identification number
fromLicensePlate(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a license plate.
fromPinCode(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a pin code.
fromQrCode(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a generated qr code.
fromWim26EncodedLicensePlate(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a hash of a license plate using the Wiegand 26 bit protocol.
fromWim64EncodedLicensePlate(String) - Static method in class net.commuty.parking.model.UserId: Creates a user id based on a hash of a license plate using the Wiegand 64 bit protocol.

G

getAt() - Method in class net.commuty.parking.model.AccessLog: The moment when the user entered/exited the parking site.
getEndTime() - Method in class net.commuty.parking.model.AccessRight: The moment (excluded) when the user is allowed (or not) anymore on the parking site.
getErrorResponse() - Method in exception net.commuty.parking.http.HttpRequestException: Returns more information linked with the request exception.
getHost() - Method in class net.commuty.parking.Configuration: Holds the host URL provided at the creation of the builder.
getHttpResponseCode() - Method in exception net.commuty.parking.http.HttpRequestException: Returns the http status code.
getId() - Method in class net.commuty.parking.model.UserId: The value of the identifier.
getMessage() - Method in interface net.commuty.parking.http.Error: A readable message.
getMessage() - Method in class net.commuty.parking.rest.JsonError
getParkingSiteId() - Method in class net.commuty.parking.model.AccessRight: The identifier of the parking site that the user is able (or not) to enter.
getPassword() - Method in class net.commuty.parking.Configuration: Holds the password provided at the creation of the builder.
getProxy() - Method in class net.commuty.parking.Configuration: Holds the Proxy provided at the creation of the builder.
getReason() - Method in interface net.commuty.parking.http.Error: A technical reason.
getReason() - Method in class net.commuty.parking.model.AccessLog: An optional reason to specify why the user has been authorized (or not) to enter.
getReason() - Method in class net.commuty.parking.rest.JsonError
getStartTime() - Method in class net.commuty.parking.model.AccessRight: The moment (included) when the user is allowed (or not) on the parking site.
getType() - Method in class net.commuty.parking.model.UserId: The identification type.
getUserId() - Method in class net.commuty.parking.model.AccessLog: The identifier of the user.
getUserIds() - Method in class net.commuty.parking.model.AccessRight: A list of known user ids known by Commuty that target the user concerning by this access right.
getUserIdType() - Method in class net.commuty.parking.model.AccessLog: The UserIdType of the identifier of the user.
getUsername() - Method in class net.commuty.parking.Configuration: Holds the username provided at the creation of the builder.
getWay() - Method in class net.commuty.parking.model.AccessLog: The direction (either AccessDirection.IN or AccessDirection.OUT) of the user entering/exiting the parking site.

H

hasType(UserIdType) - Method in class net.commuty.parking.model.UserId
HttpClient - Class in net.commuty.parking.http
HttpClient(URL, Mapper, Proxy) - Constructor for class net.commuty.parking.http.HttpClient
HttpClientException - Exception in net.commuty.parking.http: This exception will occur if there was an issue before sending any request to the client (for instance, a network issue, a proxy issue,...)
HttpClientException(Exception) - Constructor for exception net.commuty.parking.http.HttpClientException
HttpRequestException - Exception in net.commuty.parking.http: This exception will occur when the api accepted the request but returned a HTTP status 400 or above.
HttpRequestException(int, Error) - Constructor for exception net.commuty.parking.http.HttpRequestException

I

IDENTIFICATION_NUMBER - net.commuty.parking.model.UserIdType
IN - net.commuty.parking.model.AccessDirection: Indicates a user that is coming on the parking site.
isBadRequest() - Method in exception net.commuty.parking.http.HttpRequestException: Indicates if the request is a bad request (http 400).
isForbidden() - Method in exception net.commuty.parking.http.HttpRequestException: Indicates if the request is forbidden (http 403).
isGranted() - Method in class net.commuty.parking.model.AccessLog: Whether or not the user has been granted to enter/exit the parking.
isGranted() - Method in class net.commuty.parking.model.AccessRight: The status of the access right, whether the user is allowed (true) on the parking site or not (false).
isGranted(String, UserId) - Method in interface net.commuty.parking.ParkingAccess: Check whether a UserId is allowed to enter the parking site (or not) when the request is made.
isGranted(String, UserId) - Method in class net.commuty.parking.rest.ParkingAccessRestClient
isUnauthorized() - Method in exception net.commuty.parking.http.HttpRequestException: Indicates if the request is unauthorized (http 401).

J

JsonError - Class in net.commuty.parking.rest

L

LICENSE_PLATE - net.commuty.parking.model.UserIdType
LICENSE_PLATE_WIM26 - net.commuty.parking.model.UserIdType
LICENSE_PLATE_WIM64 - net.commuty.parking.model.UserIdType
listAccessRights(LocalDate, Boolean) - Method in interface net.commuty.parking.ParkingAccess: List all users (identified by one or more UserId) that are allowed or denied on the parking site for a given day.
listAccessRights(LocalDate, Boolean) - Method in class net.commuty.parking.rest.ParkingAccessRestClient
listAccessRightsForToday() - Method in interface net.commuty.parking.ParkingAccess: List all users (identified by one or more UserId) that are allowed or denied on the parking site today.
listAccessRightsForToday() - Method in class net.commuty.parking.rest.ParkingAccessRestClient
listAccessRightsForToday(boolean) - Method in interface net.commuty.parking.ParkingAccess: List all users (identified by one or more UserId) that are allowed or denied on the parking site today.
listAccessRightsForToday(boolean) - Method in class net.commuty.parking.rest.ParkingAccessRestClient

M

makeGetRequest(String, String, Map<String, String>, Class<T>) - Method in class net.commuty.parking.http.HttpClient
makePostRequest(String, String, Object, Class<T>) - Method in class net.commuty.parking.http.HttpClient
Mapper - Interface in net.commuty.parking.http

N

net.commuty.parking - package net.commuty.parking
net.commuty.parking.http - package net.commuty.parking.http
net.commuty.parking.model - package net.commuty.parking.model
net.commuty.parking.rest - package net.commuty.parking.rest

O

OUT - net.commuty.parking.model.AccessDirection: Indicates a user that is exiting the parking site.

P

ParkingAccess - Interface in net.commuty.parking: This is the client you must use to query the parking access api of Commuty.
ParkingAccessRestClient - Class in net.commuty.parking.rest
ParkingAccessRestClient(Configuration) - Constructor for class net.commuty.parking.rest.ParkingAccessRestClient
PIN_CODE - net.commuty.parking.model.UserIdType

Q

QR_CODE - net.commuty.parking.model.UserIdType

R

read(InputStream, Class<R>) - Method in interface net.commuty.parking.http.Mapper
readError(InputStream) - Method in interface net.commuty.parking.http.Mapper
REPORT_ACCESS_URL - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
REPORT_MISSING_IDS_URL - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
reportAccessLog(String, Collection<AccessLog>) - Method in interface net.commuty.parking.ParkingAccess: Report to Commuty one or more AccessLog of users that entered/exited the parking site.
reportAccessLog(String, Collection<AccessLog>) - Method in class net.commuty.parking.rest.ParkingAccessRestClient
reportMissingUserId(UserId) - Method in interface net.commuty.parking.ParkingAccess: Report any user (identified by an id and a UserIdType) that is known by you but not by Commuty.
reportMissingUserId(UserId) - Method in class net.commuty.parking.rest.ParkingAccessRestClient

S

startsAfter(LocalDateTime) - Method in class net.commuty.parking.model.AccessRight: Check if this access right's start time is after the given moment.

T

TOKEN_REQUESTS_URL - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
toRestClient() - Method in class net.commuty.parking.Configuration: Create a new ParkingAccess Rest client.
toString() - Method in class net.commuty.parking.model.AccessRight
toString() - Method in class net.commuty.parking.model.UserId
toString() - Method in class net.commuty.parking.rest.JsonError

U

UNKNOWN - net.commuty.parking.model.UserIdType
UNREAD_ONLY_PARAM - Static variable in class net.commuty.parking.rest.ParkingAccessRestClient
UserId - Class in net.commuty.parking.model: This identifies a user via one UserIdType and one identifier value.
UserIdType - Enum in net.commuty.parking.model: This indicates what is the type of the user identifier.

V

valueOf(String) - Static method in enum net.commuty.parking.model.AccessDirection: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.commuty.parking.model.UserIdType: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.commuty.parking.model.AccessDirection: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.commuty.parking.model.UserIdType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withCredentials(String, String) - Method in class net.commuty.parking.Configuration.Builder: Set a username and password to authenticate against the API
withHost(String) - Method in class net.commuty.parking.Configuration.Builder: Allow you to define a hostname that the client will use.
withProxy(Proxy) - Method in class net.commuty.parking.Configuration.Builder: Allow you to define a proxy (if it is required by your organisation).
write(Object) - Method in interface net.commuty.parking.http.Mapper

A B C D E F G H I J L M N O P Q R S T U V W
All Classes All Packages