io.kestros.commons.uilibraries.api.services.UiLibraryCacheService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kestros-sling-ui-libraries-api Show documentation
Provides UI Libraries to Sling instances, which are used for maintaining and rendering CSS and JavaScript.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 io.kestros.commons.uilibraries.api.services;

import io.kestros.commons.osgiserviceutils.exceptions.CacheBuilderException;
import io.kestros.commons.osgiserviceutils.exceptions.CacheRetrievalException;
import io.kestros.commons.osgiserviceutils.services.cache.CacheService;
import io.kestros.commons.uilibraries.api.models.FrontendLibrary;
import io.kestros.commons.uilibraries.api.models.ScriptType;
import javax.annotation.Nonnull;
import org.apache.sling.api.resource.ResourceResolver;

/**
 * Service for handling UiLibrary caches.
 */
public interface UiLibraryCacheService extends CacheService {

  /**
   * Retrieves the cached output for a specified UiLibrary.
   *
   * @param libraryPath UiLibrary to retrieve cached script for.
   * @param scriptType ScriptType (CSS or JS) to retrieve.
   * @param minified Whether to retrieved the minified version.
   * @param resourceResolver ResourceResolver to use for cache retrieval.
   *
   * @return The cached output for a specified UiLibrary.
   *
   * @throws CacheRetrievalException Cached output could not be retrieved.
   */
  @Nonnull
  String getCachedOutput(@Nonnull String libraryPath, @Nonnull ScriptType scriptType,
          boolean minified, @Nonnull ResourceResolver resourceResolver)
          throws CacheRetrievalException;

  /**
   * Retrieves the cached output for a specified UiLibrary.
   *
   * @param library UiLibrary to retrieve cached script for.
   * @param scriptType ScriptType (CSS or JS) to retrieve.
   * @param minified Whether to retrieved the minified version.
   * @param resourceResolver ResourceResolver to use for cache retrieval.
   *
   * @return The cached output for a specified UiLibrary.
   *
   * @throws CacheRetrievalException Cached output could not be retrieved.
   */
  @Nonnull
  String getCachedOutput(@Nonnull FrontendLibrary library, @Nonnull ScriptType scriptType,
          boolean minified, @Nonnull ResourceResolver resourceResolver)
          throws CacheRetrievalException;

  /**
   * Caches all scripts for the specified UiLibrary.
   *
   * @param libraryPath Path to cached library to cache.
   * @param output Compiled output.
   * @param scriptTypeInterface Script type that will be cached.
   * @param isMinified Whether the output is minified.
   * @param resourceResolver ResourceResolver to use for cache retrieval.
   *
   * @throws CacheBuilderException Cache failed to build for specified UiLibrary.
   */
  @SuppressWarnings("RedundantThrows")
  void cacheUiLibraryScript(@Nonnull String libraryPath, @Nonnull String output,
          @Nonnull ScriptType scriptTypeInterface, boolean isMinified,
          ResourceResolver resourceResolver)
          throws CacheBuilderException;
}