com.nitido.nimbox.http.services.ad.simple
Class SimpleAdService

java.lang.Object
  com.nitido.nimbox.http.services.ad.NiMAdService
      com.nitido.nimbox.http.services.ad.simple.SimpleAdService

All Implemented Interfaces:

SimpleAdServiceConstants

public class SimpleAdService
extends NiMAdService
implements SimpleAdServiceConstants

This class implements the NiMAdService interface. This Ad Service implementation loads the Ad mappings for each skin from the NiM configuration service. The configuration for this service must follow the format bellow:

• com.nitido.nimbox.http.adservice.simple.displaytrackingflag=[true|flag]
  This flag indicates wether AD Displays should be tracked by the Tracking Service. This parameter is optional with a default value set to "false"
• com.nitido.nimbox.http.adservice.simple.trackingnimletbase=< tracking nimlet URL >
  The URL to the AD Tracking Nimlet responsible for tracking AD click throughs. This parameter is optional with a default value set to an empty string.
• com.nitido.nimbox.http.addservice.simple.skinmap.< skin-ID >=< skin-URI >
  Specifies the skin URL for the given SKIN ID. This parameter is optional and no default value is set.
• com.nitido.nimbox.http.addservice.simple.admap.< skin-ID >.< location-ID >=< AD-ID >
  Specifies the AD to be displayed on a given location on a given skin. This parameter is optional and no default value is set.
• com.nitido.nimbox.http.addservice.simple.adprop.default.link= < link-url >
  Specifies the link URL for the default skin AD. This configuration parameter is required.
• com.nitido.nimbox.http.addservice.simple.adprop.default.content=< content >
  Specifies the content of the default skin AD. This configuration parameter is required.
• com.nitido.nimbox.http.addservice.simple.adprop.default.desc=< description >
  Specifies the description of the default skin AD. This configuration parameter is optional and no default value is set.
• com.nitido.nimbox.http.addservice.simple.adprop.< AD-ID >.link=< link-url >
  Specifies the link URL for the given AD id. This configuration parameter is required if the given AD id has been defined.
• com.nitido.nimbox.http.addservice.simple.adprop.< AD-ID >.content=< content >
  Specifies the content for the given AD id. This configuration parameter is required if the given AD is has been defined.
• com.nitido.nimbox.http.addservice.simple.adprop.< AD-ID >.desc=< description >
  Specifies the description for the given AD id. This configuration parameter is optional.

Field Summary

Fields inherited from class com.nitido.nimbox.http.services.ad.NiMAdService

KEY_AD_DEST, KEY_AD_SRC, KEY_TRACKING_ID

Fields inherited from interface com.nitido.nimbox.http.services.ad.simple.SimpleAdServiceConstants

AD_PROPS_DELIM_REGEX, CONF_KEY_AD_PROP_PREFIX, CONF_KEY_AD_TRACKING_NIMLET, CONF_KEY_ADMAP_PREFIX, CONF_KEY_ENABLE_DISPLAY_TRACKING, CONF_KEY_SKINMAP_PREFIX, DEF_IMAGE_ALTERNATE_TEXT, DEFAULT_AD_ID, KEY_AD_PROP_CONTENT, KEY_AD_PROP_DESCRIPTION, KEY_AD_PROP_LINKURL, KEY_SKINMAP_PREFIX_LENGTH, VALID_TRACKING_NIMLET_REGEX

Method Summary

SkinAdMap	getAdMap(Entity entity, NimletOutput output) This method returns the Ad Mapping for the skin identified in the NimletOutput parameter.
static SimpleAdService	getInstance() Returns a reference to the singleton instance of the class.

Methods inherited from class com.nitido.nimbox.http.services.ad.NiMAdService

copySkinAd, copySkinAdMap, createSkinAd, createSkinAdMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SimpleAdService getInstance()

Returns a reference to the singleton instance of the class. Invocation of This method can be assumed to be thread safe.

Returns:

Reference to the singleton instance of the class.

getAdMap

public SkinAdMap getAdMap(Entity entity,
                          NimletOutput output)

This method returns the Ad Mapping for the skin identified in the NimletOutput parameter. If no AD map is found for the given skin name, the method returns a default skin AD map with only the default AD.

Specified by:

getAdMap in class NiMAdService

Parameters:

entity - Reference to the entity object that represents the user in the system. This parameter can be null if the client request was non authenticated.

output - Reference to the output parameters produced by a Nimlet invocation. This nimlet output must