C H A P T E R 3

Transitioning Files

This chapter describes the changes for APIs and for the Desktop and Device Subscriber Portals from version 5.0 to version 5.1 of Content Delivery Server.

Changes made from version 5.0 PU1 to version 5.1 are noted below the relevant changed item.

Transitions to the following Content Delivery Server APIs occurred for version 5.1:

Changes to Content Management APIs

Changes to Content Validation APIs

Changes to Subscriber APIs

Changes to User Profile APIs

Changes to WAP Gateway APIs

Changes to Content Management APIs

The new version features the following changes and additions to the Content Management APIs from version 5.0 to version 5.1:

The following classes are added to the Content Management APIs:

ContentPreview.java

MimeType.java

Model.java

The Popularity.java interface is added.

This new interface is used to calculate the relative popularity value for content items.

ContentConstants.java has the following new fields:

public static final java.lang.String KEY_CONTENT_PREVIEWS

public static final java.lang.String TARGET_INTERFACE_WAP

public static final java.lang.String TARGET_INTERFACE_WEB

ContentInfo.java has the following new methods:

public void setValue(java.lang.String key, java.lang.Object value)

public java.lang.Object getValue(java.lang.String key)

The following method is removed from ContentInfo.java:
protected void set(java.lang.String key, java.lang.Object value).

Changes to Content Validation APIs

The new version features the following changes and additions to the Content Validation APIs:

The following field is added to ValidationContent.java:
public static java.lang.String KEY_AUTO_PUBLISH

The following methods are added to ValidationContent.java:

getCategories(java.lang.String delimiter)

getContentPreviews()

getContentType()

getDeveloperContentId()

getDeveloperName()

getDeveloperPlans()

getDeveloperUsername()

getDisplayName()

getEditionName()

getLocationType()

getMatchedModels()

For Validationcontent.java, the following argument changes are made:

The java.util.Map is changed to java.util.Map<java.lang.String,byte[]> for ValidationContent constructor.

The java.util.Map is changed to java.util.Map<java.lang.String,java.lang.String[]> for setCapabilityMap method.

The java.util.Map is changed to java.util.Map<java.lang.String,byte[]> for setMimeBytesMap method.

For Validationcontent.java, the following return type changes are made:

The java.util.Map is changed to java.util.Map<java.lang.String,java.lang.String[]> for getCapabilityMap method.

The java.util.Map is changed to java.util.Map<java.lang.String,byte[]> for getMimeBytesMap method.

Changes to Subscriber APIs

The new version features the following changes and additions to the Subscriber APIs:

The following interfaces are added to the Subscriber APIs:

IContentPreview

ICustomField

IMimeType

IStreamingService

The following methods for ApiContextFactory.java are added:

createAnonymousApiContext(java.lang.String localeCode, long modelId, boolean expires)

isAuthKeyValid(java.lang.String authKey)

removeApiContext(java.lang.String authKey)

The following method for ApiUtil.java is added:
isContentExpired(long contentId)

The following fields for CDSException.java are added:

public static final java.lang.String CDS_EX_DOWNLOAD_BEFORE_START_DATE_NOT_ALLOWED

Added in version 5.0 PU1.

public static final java.lang.String CDS_EX_INVALID_AUTH_KEY

The following field for CDSException.java is removed:
public static final java.lang.String CDS_EX_INVALID_URL_TICKET

The following method is added to IApiContext.java: getAuthKey()

The following method is added to ICategory.java: getSortingQuery()

For ICategoryService.java, the argument java.util.Collection is changed to java.util.Collection<ICategory> for the following methods:

hideCategory()

moveCategoryDown()

moveCategoryUp()

showCategory()

For ICategoryService.java, the return typejava.util.Collection is changed to java.util.Collection<ICategory> for the following methods:

getNotEmptySubCategories()

getSubCategories()

hideCategory()

moveCategoryDown()

moveCategoryUp()

showCategory()

The following methods for IContentDetails.java are added:

getUserGuideBinary()

getSmallIconBinary()

java.util.Collection<IContentPreview> getPreviews(int target)

java.util.Collection<IContentPreview> getPreviews()

getLargeIconBinary()

getDeviceIconBinary()

The following methods for IContentDetails.java are deprecated:

getPreviewUrl()

Use getPreviews(int) instead.

getScreenShot1Url()

Use getPreviews(int) instead.

getScreenShot2Url()

Use getPreviews(int) instead.

isPreviewEnabled()

The following methods for IContentDetails.java are removed:

getContentClassId()

Removed in version 5.0 PU1.

getContentKeyword()

Removed in version 5.0 PU1.

getContentType()

Removed in version 5.0 PU1.

getDeveloperName()

Removed in version 5.0 PU1.

getLongDescription()

getSizeInKB()

getVersion()

isBundle()

For IContentList.java, the java.util.Collection return type is changed to java.util.Collection<IContentSummary> for getContentSummaries method.

The following fields for IContentService.java are added:

public static final java.lang.String DETAILS_INCLUDE_CUSTOM_FIELDS

public static final java.lang.String DETAILS_INCLUDE_RESOURCE_BINARIES

public static final java.lang.String TARGET_INTERFACE_WAP

public static final java.lang.String TARGET_INTERFACE_WEB

The following changes are made to IContentService.java:

The method searchContent(java.lang.String searchQuery,
long categoryId, java.util.Map<java.lang.String,java.lang.Boolean> sortKeyMap, int numberToReturn, int startIndex) is added.

The method IContentList searchContent(long categoryId, java.lang.String searchStr, long[] contentTypeIds, int numberToReturn, int startIndex) is deprecated.

Use searchContent(String, long, Map, int, int) instead.

For IContentService.java, the java.util.Collection argument is changed to java.util.Collection<IContentSummary> for getContentDetails(java.util.Collection<IContentSummary> contentSummaries, IContentDetailsCriteria criteria) method.

For IContentService.java, the java.util.Collection argument is changed to java.util.Collection<IContentSummary> for the following deprecated methods:

getContentDetails(java.util.Collection<IContentSummary> contentSummaries, java.util.BitSet filter, long campaignId, long bundleId, boolean isSkipTrial)

getContentDetails(java.util.Collection<IContentSummary> contentSummaries, java.util.BitSet filter, long campaignId, long bundleId, boolean retailPrice, boolean isSkipTrial)

For IContentService.java, the java.util.Collection return type is changed to java.util.Collection<IContentDetails> for all getContentDetails methods.

For IContentService.java, the java.util.Collection return type is changed to java.util.Collection<IPurchaseDetails> for getPurchases method.

For IContentService.java, the java.util.Collection return type is changed to java.util.Collection<IModel> for getSupportedModels method.

For IContentService.java, the java.util.Collection return type is changed to java.util.Collection<IContentSummary> for getBookmarks method.

For IContentService.java, the java.util.Collection return type is changed to java.util.Collection<ICampaign> for the getCampaigns method.

The following methods for IContentType.java are added:

getContentClassId()

getContentKeyword()

getContentType()

getCustomFields()

getDeveloperName()

getLongDescription()

getSizeInKB()

getVersion()

isBundle()

For IDownloadService.java,the java.util.Map argument is changed to java.util.Map<java.lang.String,java.lang.Object> for the following methods:

pushSMSContent(java.lang.String mobileId, byte[] contentBinary, java.lang.String mimeType, java.lang.String contentType, java.util.Map<java.lang.String,java.lang.Object> params)

pushSMSContent(java.lang.String ticket, java.util.Map<java.lang.String,java.lang.Object> params)

The following method is added to IGiftingService.java:giftContent(long contentId, long campaignId, IApiContext recipientCtx, java.lang.String message, int giftedDownloads, int giftedSubscriptions, java.util.Map<java.lang.String,java.lang.String> billingParams)

ForIGiftingService.java, the java.util.Collection return type is changed to java.util.Collection<IGifting> for the following methods:

getGiftingsByGifter()

getGiftingsByRecipient()

For ISystemService.java, the java.util.Collection return type is changed to java.util.Collection<IContentType> for getContentTypes() method.

For ISystemService.java, the java.util.Collection return type is changed to java.util.Collection<ICountry> for getCountries() method.

For ISystemService.java, the java.util.Collection return type is changed to java.util.Collection<ILocale> for getLocales() method.

For ISystemService.java, the java.util.Collection return type is changed to java.util.Collection<IModel> for the following methods:

getModels()

getModels(java.lang.String manufacturer)

The following methods for IUserService.java are deprecated:

getCategoryService(IApiContext context)

Use getCategoryService(String) instead.

getCategoryService(java.lang.String authKey)

getContentService(IApiContext context)

Use getContentService(String) instead.

getContentService(java.lang.String authKey)

getDownloadService(IApiContext context)

Use getDownloadService(String) instead.

getDownloadService(java.lang.String authKey)

getGiftingService(IApiContext context)

Use getGiftingService(String) instead.

getGiftingService(java.lang.String authKey)

getMessageService(IApiContext context)

Use getMessageService(String) instead.

getMessageService(java.lang.String authKey)

getStreamingService(IApiContext context)

Use getStreamingService(String) instead.

getStreamingService(java.lang.String authKey)

getSystemService(IApiContext context)

Use getSystemService(String) instead.

getSystemService(java.lang.String authKey)

getUserService(IApiContext context)

Use getUserService(String) instead.

getUserService(java.lang.String authKey)

For IUserService.java, the java.util.Map argument is changed to java.util.Map<java.lang.String,java.lang.Object> for setUserPreferences() method.

For IUserService.java, the java.util.Map argument is changed to java.util.Map<java.lang.String,java.lang.Object> for setUserProperties() method.

For IUserService.java, the java.util.Map argument is changed to java.util.Map<java.lang.String,java.lang.String> for signup() method.

For IUserService.java, the java.util.Map return type is changed to java.util.Map<java.lang.String,java.lang.Object> for getUserPreferences() method.

For IUserService.java, the java.util.Map return type is changed to java.util.Map<java.lang.String,java.lang.String> for the following methods:

getUserProperties()

getUserProperties(long subscriberId)

getUserProperties(java.lang.String userName)

Changes to User Profile APIs

The new version features the following changes and additions to the User Profile APIs:

The interface, UserDeviceModel.java, is added.

The following methods for User.java are deprecated:

getAttributes()

getAttribute(java.lang.String name)

getAttribute(java.lang.String name, java.lang.Object defaultValue)

getCreateDate()

getLastLogin()

hasLoggedIn()

isConfirmed()

setAttribute(java.lang.String name, java.lang.Object value)

setAttributes(java.util.Hashtable attributes)

setCreateDate(java.util.Date date)

setHasLoggedIn(boolean value)

updateLastLogin()

UserManager.java has the following new fields:

public static final long DEVICE_MODEL_IGNORE

public static final long DEVICE_MODEL_UNKNOWN

The following fields for UserManager.java, are deprecated:

public static final int ID

public static final int LAST_NAME

public static final int FIRST_NAME

public static final int LOGIN_NAME

public static final int STATUS

public static final int KEY

The following methods for UserManager.java are deprecated:

accountExists(java.lang.String userId)

disableUser(java.lang.String userId)

Use disableUser(User) instead.

doAccountExists(java.lang.String userId)

doEnableUser(java.lang.String userId)

Use doEnableUser(User) instead.

doGetAllLikeInOrder(java.lang.String[] columns, java.lang.String[] values, java.lang.String[] orders, boolean isDescending, int pageNum, int recPerPage, java.lang.String role)

doGetAllUsers(java.lang.String role)

doGetAllUsersContainingFirstName(java.lang.String firstName, java.lang.String role)

doGetAllUsersContainingId(java.lang.String userId, java.lang.String role)

doGetAllUsersContainingLastName(java.lang.String lastName, java.lang.String role)

doGetAllUsersContainingName(java.lang.String name, java.lang.String role)

doGetAnonymousUser()

doGetFieldName(int fieldConstant, java.lang.String role)

doGetUser(java.lang.String userId)

Use doGetUserByLoginId(String)instead.

doIsActive(java.lang.String userId)

doIsAuthenticated(java.lang.String inUserId, java.lang.String inPassword)

Use doAuthenticatePassword(User, String)instead.

doRemoveUser(java.lang.String userId)

Use doRemoveUser(User)instead.

enableUser(java.lang.String userId)

Use enableUser(User)instead.

getAllLikeInOrder(java.lang.String[] columns, java.lang.String[] values, java.lang.String[] orders, boolean isDescending, int pageNum, int recPerPage)

getAllLikeInOrder(java.lang.String[] columns, java.lang.String[] values, java.lang.String[] orders, boolean isDescending, int pageNum, int recPerPage, java.lang.String role)

getAllUsers()

getAllUsers(java.lang.String role)

getAllUsersContainingFirstName(java.lang.String firstName)

getAllUsersContainingFirstName(java.lang.String firstName, java.lang.String role)

getAllUsersContainingId(java.lang.String userId)

getAllUsersContainingId(java.lang.String userId, java.lang.String role)

getAllUsersContainingLastName(java.lang.String lastName)

getAllUsersContainingLastName(java.lang.String lastName, java.lang.String role)

getAllUsersContainingName(java.lang.String name)

getAllUsersContainingName(java.lang.String nameLike, java.lang.String role)

getAnonymousUser()

getFieldName(int fieldConstant)

getFieldName(int fieldConstant, java.lang.String role)

getUser(java.lang.String userId)

Use getUserByLoginId(String)instead.

isActive(java.lang.String userId)

isAuthenticated(java.lang.String inUserId, java.lang.String inPassword)

Use authenticatePassword(User, String) instead.

removeUser(java.lang.String userId)

Use removeUser(User) instead.

For a complete list of deprecated security methods, see the deprecated-list.html file in $CDS_HOME/javadoc/cdsapi directory.

Changes to WAP Gateway APIs

The new version features changes and additions to the WAP Gateway APIs. The following fields are added to WAPGatewayAdapter.java:

public static final java.lang.String HANDLE_MSISDN

public static final java.lang.String HANDLE_MSISDN_MAP

public static final java.lang.String HANDLE_UNIQUE_ID

public static final java.lang.String HANDLE_UNIQUE_ID_MAP