Returns a {@link Status} appropriate for the given {@link * Throwable}.
* *Note that illegal arguments from the client, which would be * intended to produce a 400 status, should be represented * by {@link IllegalClientArgumentException}. In contrast, {@link * IllegalArgumentException} will produce a 500 response.
*/ @Override public Status toStatus(Throwable t, Request request, Response response) { Status status; t = (t.getCause() != null) ? t.getCause() : t; if (t instanceof ResourceException) { status = ((ResourceException) t).getStatus(); } else if (t instanceof IllegalClientArgumentException || t instanceof UnsupportedEncodingException) { status = new Status(Status.CLIENT_ERROR_BAD_REQUEST, t); } else if (t instanceof UnsupportedOutputFormatException) { status = new Status(Status.CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE, t); } else if (t instanceof FileNotFoundException || t instanceof NoSuchFileException) { status = new Status(Status.CLIENT_ERROR_NOT_FOUND, t); } else if (t instanceof AccessDeniedException) { status = new Status(Status.CLIENT_ERROR_FORBIDDEN, t); } else if (t instanceof UnsupportedSourceFormatException) { status = new Status(Status.SERVER_ERROR_NOT_IMPLEMENTED, t); } else { status = new Status(Status.SERVER_ERROR_INTERNAL, t); } return status; } } /** * Verifies given user credentials against a single set of stored user * credentials in the application configuration. */ private static class ConfigurationVerifier extends LocalVerifier { private final Key userKey; private final Key secretKey; /** * @param userKey Key under which the username is stored. * @param secretKey Key under which the secret is stored. */ ConfigurationVerifier(Key userKey, Key secretKey) { this.userKey = userKey; this.secretKey = secretKey; } @Override public char[] getLocalSecret(String givenUser) { final Configuration config = Configuration.getInstance(); if (config.getString(userKey).equals(givenUser)) { return config.getString(secretKey).toCharArray(); } return null; } /** * Overrides super to disallow an empty stored secret. */ @Override public int verify(String identifier, char[] secret) { final Configuration config = Configuration.getInstance(); final String configSecret = config.getString(secretKey); if (configSecret == null || configSecret.isEmpty()) { return RESULT_INVALID; } return super.verify(identifier, secret); } } public static final String ADMIN_PATH = "/admin"; public static final String ADMIN_CONFIG_PATH = "/admin/configuration"; public static final String ADMIN_STATUS_PATH = "/status"; public static final String CONFIGURATION_PATH = "/configuration"; public static final String IIIF_PATH = "/iiif"; public static final String IIIF_1_PATH = "/iiif/1"; public static final String IIIF_2_PATH = "/iiif/2"; public static final String STATIC_ROOT_PATH = "/static"; public static final String TASKS_PATH = "/tasks"; public static final String ADMIN_REALM = edu.illinois.library.cantaloupe.Application.getName() + " Control Panel"; public static final String API_REALM = edu.illinois.library.cantaloupe.Application.getName() + " API Realm"; public static final String PUBLIC_REALM = "Image Realm"; public GSRestletApplication() { super(); // Tell Restlet to use a custom status service for transforming // uncaught exceptions into error responses. setStatusService(new CustomStatusService()); // Enable CORS. // See: http://restlet.com/blog/2015/12/15/understanding-and-using-cors/ CorsService corsService = new CorsService(); corsService.setAllowedOrigins(new HashSet<>(Collections.singletonList("*"))); corsService.setAllowedCredentials(true); getServices().add(corsService); // Disable support for ranging. This will tell Restlet not to honor the // Range request header, as well as not to send an Accept-Ranges header. getRangeService().setEnabled(false); } private Authenticator newAdminAuthenticator() { ChallengeAuthenticator auth = new ChallengeAuthenticator( getContext(), ChallengeScheme.HTTP_BASIC, ADMIN_REALM); auth.setVerifier(new ConfigurationVerifier( Key.ADMIN_USERNAME, Key.ADMIN_SECRET)); return auth; } private Authenticator newAPIAuthenticator() { ChallengeAuthenticator auth = new ChallengeAuthenticator( getContext(), ChallengeScheme.HTTP_BASIC, API_REALM); auth.setVerifier(new ConfigurationVerifier( Key.API_USERNAME, Key.API_SECRET)); return auth; } private Authenticator newPublicEndpointAuthenticator() { final Configuration config = Configuration.getInstance(); if (config.getBoolean(Key.BASIC_AUTH_ENABLED, false)) { getLogger().log(Level.INFO, "Enabling HTTP Basic authentication for public endpoints"); final ChallengeAuthenticator auth = new ChallengeAuthenticator( getContext(), ChallengeScheme.HTTP_BASIC, PUBLIC_REALM) { @Override protected int beforeHandle(Request request, Response response) { final String path = request.getResourceRef().getPath(); if (path.startsWith(IIIF_PATH)) { return super.beforeHandle(request, response); } response.setStatus(Status.SUCCESS_OK); return CONTINUE; } }; auth.setVerifier(new ConfigurationVerifier( Key.BASIC_AUTH_USERNAME, Key.BASIC_AUTH_SECRET)); return auth; } else { getLogger().info("Public endpoint authentication is disabled (" + Key.BASIC_AUTH_ENABLED + " = false)"); } return null; } /** * Creates a root Restlet that will receive all incoming calls. * * @see URI Syntax */ @Override public Restlet createInboundRoot() { final Router router = new Router(getContext()); router.setDefaultMatchingMode(Template.MODE_EQUALS); ////////////////////// IIIF Image API routes /////////////////////// // Redirect IIIF_PATH/ to IIIF_PATH router.attach(IIIF_PATH + "/", TrailingSlashRemovingResource.class); // Redirect IIIF_PATH to IIIF_2_PATH router.attach(IIIF_PATH, RedirectingResource.class); //////////////////// IIIF Image API 1.x routes ///////////////////// // landing page router.attach(IIIF_1_PATH, edu.illinois.library.cantaloupe.resource.iiif.v1.LandingResource.class); // Redirect IIIF_1_PATH/ to IIIF_1_PATH router.attach(IIIF_1_PATH + "/", TrailingSlashRemovingResource.class); // image request router.attach(IIIF_1_PATH + "/{identifier}/{region}/{size}/{rotation}/{quality_format}", edu.illinois.library.cantaloupe.resource.iiif.v1.ImageResource.class); // information request router.attach(IIIF_1_PATH + "/{identifier}", edu.illinois.library.cantaloupe.resource.iiif.v1.InformationResource.RedirectingResource.class); router.attach(IIIF_1_PATH + "/{identifier}/info.json", edu.illinois.library.cantaloupe.resource.iiif.v1.InformationResource.class); //////////////////// IIIF Image API 2.x routes ///////////////////// // landing page router.attach(IIIF_2_PATH, edu.illinois.library.cantaloupe.resource.iiif.v2.LandingResource.class); // Redirect IIIF_2_PATH/ to IIIF_2_PATH router.attach(IIIF_2_PATH + "/", TrailingSlashRemovingResource.class); // image request router.attach(IIIF_2_PATH + "/{identifier}/{region}/{size}/{rotation}/{quality}.{format}", edu.illinois.library.cantaloupe.resource.iiif.v2.GSImageResource.class); // information request router.attach(IIIF_2_PATH + "/{identifier}", edu.illinois.library.cantaloupe.resource.iiif.v2.GSInformationResource.RedirectingResource.class); router.attach(IIIF_2_PATH + "/{identifier}/info.json", edu.illinois.library.cantaloupe.resource.iiif.v2.GSInformationResource.class); ////////////////////////// Admin routes /////////////////////////// Authenticator adminAuth = newAdminAuthenticator(); adminAuth.setNext(AdminResource.class); router.attach(ADMIN_PATH, adminAuth); adminAuth = newAdminAuthenticator(); adminAuth.setNext(edu.illinois.library.cantaloupe.resource.admin.ConfigurationResource.class); router.attach(ADMIN_CONFIG_PATH, adminAuth); adminAuth = newAdminAuthenticator(); adminAuth.setNext(StatusResource.class); router.attach(ADMIN_STATUS_PATH, adminAuth); /////////////////////////// API routes //////////////////////////// Authenticator apiAuth = newAPIAuthenticator(); apiAuth.setNext(edu.illinois.library.cantaloupe.resource.api.ConfigurationResource.class); router.attach(CONFIGURATION_PATH, apiAuth); apiAuth = newAPIAuthenticator(); apiAuth.setNext(TasksResource.class); router.attach(TASKS_PATH, apiAuth); apiAuth = newAPIAuthenticator(); apiAuth.setNext(TaskResource.class); router.attach(TASKS_PATH + "/{uuid}", apiAuth); ////////////////////////// Other routes /////////////////////////// // Application landing page router.attach("/", GSLandingResource.class); // Hook up the static file server (for images, CSS, & scripts) // This uses Restlet's "CLAP" (Class Loader Access Protocol) mechanism // which must be enabled in web.xml. final Directory dir = new Directory( getContext(), "clap://resources/public_html/"); dir.setDeeplyAccessible(true); dir.setListingAllowed(false); dir.setNegotiatingContent(false); router.attach(STATIC_ROOT_PATH, dir); // Hook up public endpoint authentication Authenticator endpointAuth = newPublicEndpointAuthenticator(); if (endpointAuth != null) { endpointAuth.setNext(router); return endpointAuth; } return router; } }