DynamicSkinUniqueTokenGenerator.java

/**
 * Licensed to Apereo under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Apereo 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 the following location:
 *
 *   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 org.apereo.portal.portlets.dynamicskin;

/**
 * Interface for classes used to generate a unique token for a dynamic skin using the {@link DynamicSkinInstanceData}.
 * The purpose of the generated token is for it to be used to uniquely name the skin less and css files and to 
 * determine when LESS recompilation is needed due to the token value being stale.
 */
public interface DynamicSkinUniqueTokenGenerator {

    /**
     * Generates and returns the token.
     * 
     * @param data current skin instance data
     * @return unique token for current skin instance
     */
    String generateToken(final DynamicSkinInstanceData data);

}