BaseUrlResolver.java

/*
 * #%L
 * BroadleafCommerce Common Libraries
 * %%
 * Copyright (C) 2009 - 2013 Broadleaf Commerce
 * %%
 * Licensed 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.
 * #L%
 */

package org.broadleafcommerce.common.web;

/**
 * Responsible for providing the base url for the site / admin applications.
 * 
 * @author Andre Azzolini (apazzolini)
 */
public interface BaseUrlResolver {

    /**
     * Returns the currently configured base url for the site. The default implementation of this interface
     * will return the value stored in the site.baseurl property for the current environment.
     * 
     * For example, in a development environment, this method might return: http://localhost:8080
     * 
     * @return the site baseurl, without a trailing slash
     */
    public String getSiteBaseUrl();

    /**
     * Returns the currently configured base url for the admin. The default implementation of this interface
     * will return the value stored in the admin.baseurl property for the current environment.
     * 
     * For example, in a development environment, this method might return: http://localhost:8080/admin
     * 
     * @return the admin baseurl, without a trailing slash
     */
    public String getAdminBaseUrl();

}