org.broadleafcommerce.openadmin.client.service
Interface UtilityService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

UtilityRemoteService

public interface UtilityService
extends com.google.gwt.user.client.rpc.RemoteService

UtilityService provides several basic function to the admin revolving around retrieving current context information for the admin app. NOTE - this service is NOT secured. Do not put features in this service interface that require security!

Author:

jfischer

Method Summary

java.lang.String	getStoreFrontWebAppContext() Retrieve the current web application context (if any) for the actual store front associated with this admin instance.
java.lang.String	getWebAppContext() Retrieve the current web application context (if any) in use for this admin application.

Method Detail

getWebAppContext

java.lang.String getWebAppContext()
                                  throws ServiceException,
                                         com.gwtincubator.security.exception.ApplicationSecurityException

Retrieve the current web application context (if any) in use for this admin application. When a web app context is in use, it appears as the first part of the url. For example, in the url http://localhost:8080/broadleafdemo/admin.html, the web app context is 'broadleafdemo'. Null may be returned if there is no app context.

Returns:

The first part of the app url that constitutes the web application context (if any).

Throws:

ServiceException

com.gwtincubator.security.exception.ApplicationSecurityException

getStoreFrontWebAppContext

java.lang.String getStoreFrontWebAppContext()
                                            throws ServiceException,
                                                   com.gwtincubator.security.exception.ApplicationSecurityException

Retrieve the current web application context (if any) for the actual store front associated with this admin instance. For example, if the storefront is http://localhost:8080/myStore, then the store front web app context is 'myStore'. Null may be returned if there is no web app context set for the storefront.

Returns:

The first part of the storefront url that constitutes the web application context (if any)

Throws:

ServiceException

com.gwtincubator.security.exception.ApplicationSecurityException