org.broadleafcommerce.common.site.domain
Class SiteImpl

java.lang.Object
  extended by org.broadleafcommerce.common.site.domain.SiteImpl
All Implemented Interfaces:
Serializable, Site

@Entity
public class SiteImpl
extends Object
implements Site

Created by bpolster.

See Also:
Serialized Form

Field Summary
protected  Long id
           
protected  String name
           
protected  SandBox productionSandbox
           
protected  String siteIdentifierType
           
protected  String siteIdentifierValue
           
 
Constructor Summary
SiteImpl()
           
 
Method Summary
 Long getId()
          Unique/internal id for a site.
 String getName()
          The display name for a site.
 SandBox getProductionSandbox()
          If null, then this is a single-site installation.
 String getSiteIdentifierType()
          Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site.
 String getSiteIdentifierValue()
          Used along with #getSiteIdentiferType() to determine the current Site for a given request.
 void setId(Long id)
          Sets the internal id for a site.
 void setName(String name)
          Sets the displayName for a site.
 void setProductionSandbox(SandBox productionSandbox)
          Sets the production sandbox.
 void setSiteIdentifierType(String siteIdentifierType)
          Sets the site identifier type.
 void setSiteIdentifierValue(String siteIdentifierValue)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected Long id

name

protected String name

siteIdentifierType

protected String siteIdentifierType

siteIdentifierValue

protected String siteIdentifierValue

productionSandbox

protected SandBox productionSandbox
Constructor Detail

SiteImpl

public SiteImpl()
Method Detail

getId

public Long getId()
Description copied from interface: Site
Unique/internal id for a site.

Specified by:
getId in interface Site
Returns:

setId

public void setId(Long id)
Description copied from interface: Site
Sets the internal id for a site.

Specified by:
setId in interface Site

getName

public String getName()
Description copied from interface: Site
The display name for a site.

Specified by:
getName in interface Site
Returns:

setName

public void setName(String name)
Description copied from interface: Site
Sets the displayName for a site.

Specified by:
setName in interface Site

getSiteIdentifierType

public String getSiteIdentifierType()
Description copied from interface: Site
Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site. Example type usage could be HOSTNAME, IP-ADDRESS, URL-PARAMETER. Custom SiteResolvers can be written to determine the current Site.

Specified by:
getSiteIdentifierType in interface Site
Returns:

setSiteIdentifierType

public void setSiteIdentifierType(String siteIdentifierType)
Description copied from interface: Site
Sets the site identifier type.

Specified by:
setSiteIdentifierType in interface Site
See Also:
Site.getSiteIdentifierType()

getSiteIdentifierValue

public String getSiteIdentifierValue()
Description copied from interface: Site
Used along with #getSiteIdentiferType() to determine the current Site for a given request.

Specified by:
getSiteIdentifierValue in interface Site
Returns:

setSiteIdentifierValue

public void setSiteIdentifierValue(String siteIdentifierValue)
Specified by:
setSiteIdentifierValue in interface Site

getProductionSandbox

public SandBox getProductionSandbox()
Description copied from interface: Site
If null, then this is a single-site installation. Otherwise, each site must define it's production sandbox so that data can be properly segmented.

Specified by:
getProductionSandbox in interface Site
Returns:

setProductionSandbox

public void setProductionSandbox(SandBox productionSandbox)
Description copied from interface: Site
Sets the production sandbox. Typically configured via the database.

Specified by:
setProductionSandbox in interface Site
See Also:
Site.getProductionSandbox();


Copyright © 2013. All Rights Reserved.