AdapterException

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.ibm.commerce.soccom.adapter.AdapterException

All Implemented Interfaces:

java.io.Serializable
```
public class AdapterException
extends java.lang.Exception
```
AdapterException is thrown by service adapter API methods. Adapter methods should try to reuse the existing exceptions defined below before instantiating new ones.
In order to allow client-side translation of the error messages, each AdapterException instance should provide a unique message ID as its message value. This message ID can be mapped to a human-readable translated message by the client.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` Copy Right Statement
`static AdapterException`	`DUPLICATE_RECOMMENDATION` The user cannot create multiple recommendations for the same item
`static AdapterException`	`ERR_CONNECT_SERVICE` The service is unavailable.
`static AdapterException`	`ERR_CREATE_BLOG` Failed to create the blog.
`static AdapterException`	`ERR_CREATE_COMMENT` Failed to create a comment.
`static AdapterException`	`ERR_CREATE_ENTRY` Failed to create the entry.
`static AdapterException`	`ERR_CREATE_PROFILE` Failed to create the user profile.
`static AdapterException`	`ERR_CREATE_REVIEW` Failed to create a review.
`static AdapterException`	`ERR_DELETE_ENTRY` Failed to delete the entry.
`static AdapterException`	`ERR_DUPLICATE_REVIEW` The review already exists.
`static AdapterException`	`ERR_FETCHING_PROFILE` Failed to update the user profile.
`static AdapterException`	`ERR_FLAG_ENTRY` Failed to flag the entry as inappropriate.
`static AdapterException`	`ERR_INVALID_PAGE_NUMBER` Invalid page number parameter.
`static AdapterException`	`ERR_INVALID_PAGE_SIZE` Invalid page size parameter.
`static AdapterException`	`ERR_NO_ADMIN_SET` The administrative user is not configured in the config/adapter.config configuration file.
`static AdapterException`	`ERR_NOT_AUTHORIZED` User attempted to perform an unauthorized action.
`static AdapterException`	`ERR_NOT_LOGGED_IN` User is not logged in.
`static AdapterException`	`ERR_PHOTO_UPLOAD_FAILED` Failed to upload photo.
`static AdapterException`	`ERR_PROFILE_INVALID_USER_ID` The profile requested is for an invalid user ID.
`static AdapterException`	`ERR_PROFILE_UNAUTHORIZED` Not authorized to update profile.
`static AdapterException`	`ERR_RETRIEVE_COMMENT` Failed to retrieve comments.
`static AdapterException`	`ERR_RETRIEVE_ENTRY` Failed to retrieve the review.
`static AdapterException`	`ERR_RETRIEVE_PROFILE` Failed to retrieve the user's profile.
`static AdapterException`	`ERR_RETRIEVE_REVIEW` Failed to retrieve a review.
`static AdapterException`	`ERR_REVIEW_INVALID_ITEM_HANDLE` The review referred to an invalid item.
`static AdapterException`	`ERR_REVIEW_INVALID_USER_ID` The reviews could not be retrieved for the given user.
`static AdapterException`	`ERR_SHARE_IT_BLOG` Failed to Share the blog with Social Network.
`static AdapterException`	`ERR_TIMEOUT` The request timed out.
`static AdapterException`	`ERR_UPDATE_PROFILE` Failed to update the user profile.
`static AdapterException`	`ERROR_CREATING_UPDATING_PROFILE` Failed to update the user profile.
`static AdapterException`	`ERROR_RETRIEVING_BLOG` Failed to retrieve the blog.
`static AdapterException`	`ERROR_RETRIEVING_MEDIA` Failed to retrieve the entry.
`static AdapterException`	`INVALID_QUERY_PARAM` Invalid query parameter.
`static AdapterException`	`INVALID_RESOURCE_ID` One or more resource IDs in the URL are invalid.
`static AdapterException`	`INVALID_USERNAME` User is invalid or is not authenticated.
`static AdapterException`	`OAUTH_TIMESTAMP_ERROR` The OAuth response indicates that the timestamp is too far from the expected value.

Constructor Summary

Constructors
Constructor and Description
`AdapterException(java.lang.String message)` Constructs a new AdapterException with the given message.
`AdapterException(java.lang.String message, java.lang.Throwable cause)` Constructs a new AdapterException with the given message and cause.
`AdapterException(java.lang.Throwable cause)` Constructs a new AdapterException with the given cause.

Method Summary
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    Copy Right Statement
    
    See Also:
    
    Constant Field Values
  - INVALID_USERNAME
```
public static final AdapterException INVALID_USERNAME
```
    User is invalid or is not authenticated.
  - INVALID_RESOURCE_ID
```
public static final AdapterException INVALID_RESOURCE_ID
```
    One or more resource IDs in the URL are invalid.
  - INVALID_QUERY_PARAM
```
public static final AdapterException INVALID_QUERY_PARAM
```
    Invalid query parameter.
  - ERR_NOT_LOGGED_IN
```
public static final AdapterException ERR_NOT_LOGGED_IN
```
    User is not logged in.
  - ERR_NOT_AUTHORIZED
```
public static final AdapterException ERR_NOT_AUTHORIZED
```
    User attempted to perform an unauthorized action.
  - ERR_NO_ADMIN_SET
```
public static final AdapterException ERR_NO_ADMIN_SET
```
    The administrative user is not configured in the config/adapter.config configuration file.
  - ERR_RETRIEVE_REVIEW
```
public static final AdapterException ERR_RETRIEVE_REVIEW
```
    Failed to retrieve a review.
  - ERR_DUPLICATE_REVIEW
```
public static final AdapterException ERR_DUPLICATE_REVIEW
```
    The review already exists.
  - ERR_CREATE_REVIEW
```
public static final AdapterException ERR_CREATE_REVIEW
```
    Failed to create a review.
  - ERR_REVIEW_INVALID_ITEM_HANDLE
```
public static final AdapterException ERR_REVIEW_INVALID_ITEM_HANDLE
```
    The review referred to an invalid item.
  - ERR_REVIEW_INVALID_USER_ID
```
public static final AdapterException ERR_REVIEW_INVALID_USER_ID
```
    The reviews could not be retrieved for the given user.
  - ERR_TIMEOUT
```
public static final AdapterException ERR_TIMEOUT
```
    The request timed out.
  - DUPLICATE_RECOMMENDATION
```
public static final AdapterException DUPLICATE_RECOMMENDATION
```
    The user cannot create multiple recommendations for the same item
  - ERR_CONNECT_SERVICE
```
public static final AdapterException ERR_CONNECT_SERVICE
```
    The service is unavailable.
  - ERR_PHOTO_UPLOAD_FAILED
```
public static final AdapterException ERR_PHOTO_UPLOAD_FAILED
```
    Failed to upload photo.
  - ERR_INVALID_PAGE_SIZE
```
public static final AdapterException ERR_INVALID_PAGE_SIZE
```
    Invalid page size parameter.
  - ERR_INVALID_PAGE_NUMBER
```
public static final AdapterException ERR_INVALID_PAGE_NUMBER
```
    Invalid page number parameter.
  - ERR_CREATE_ENTRY
```
public static final AdapterException ERR_CREATE_ENTRY
```
    Failed to create the entry.
  - ERROR_RETRIEVING_BLOG
```
public static final AdapterException ERROR_RETRIEVING_BLOG
```
    Failed to retrieve the blog.
  - ERR_RETRIEVE_ENTRY
```
public static final AdapterException ERR_RETRIEVE_ENTRY
```
    Failed to retrieve the review.
  - ERROR_RETRIEVING_MEDIA
```
public static final AdapterException ERROR_RETRIEVING_MEDIA
```
    Failed to retrieve the entry.
  - ERR_DELETE_ENTRY
```
public static final AdapterException ERR_DELETE_ENTRY
```
    Failed to delete the entry.
  - ERR_FLAG_ENTRY
```
public static final AdapterException ERR_FLAG_ENTRY
```
    Failed to flag the entry as inappropriate.
  - ERR_CREATE_COMMENT
```
public static final AdapterException ERR_CREATE_COMMENT
```
    Failed to create a comment.
  - ERR_RETRIEVE_COMMENT
```
public static final AdapterException ERR_RETRIEVE_COMMENT
```
    Failed to retrieve comments.
  - ERR_RETRIEVE_PROFILE
```
public static final AdapterException ERR_RETRIEVE_PROFILE
```
    Failed to retrieve the user's profile.
  - ERR_PROFILE_INVALID_USER_ID
```
public static final AdapterException ERR_PROFILE_INVALID_USER_ID
```
    The profile requested is for an invalid user ID.
  - ERR_CREATE_PROFILE
```
public static final AdapterException ERR_CREATE_PROFILE
```
    Failed to create the user profile.
  - ERR_UPDATE_PROFILE
```
public static final AdapterException ERR_UPDATE_PROFILE
```
    Failed to update the user profile.
  - ERROR_CREATING_UPDATING_PROFILE
```
public static final AdapterException ERROR_CREATING_UPDATING_PROFILE
```
    Failed to update the user profile.
  - ERR_FETCHING_PROFILE
```
public static final AdapterException ERR_FETCHING_PROFILE
```
    Failed to update the user profile.
  - ERR_PROFILE_UNAUTHORIZED
```
public static final AdapterException ERR_PROFILE_UNAUTHORIZED
```
    Not authorized to update profile.
  - ERR_CREATE_BLOG
```
public static final AdapterException ERR_CREATE_BLOG
```
    Failed to create the blog.
  - ERR_SHARE_IT_BLOG
```
public static final AdapterException ERR_SHARE_IT_BLOG
```
    Failed to Share the blog with Social Network.
  - OAUTH_TIMESTAMP_ERROR
```
public static final AdapterException OAUTH_TIMESTAMP_ERROR
```
    The OAuth response indicates that the timestamp is too far from the expected value.
- Constructor Detail
  - AdapterException
```
public AdapterException(java.lang.String message)
```
    Constructs a new AdapterException with the given message. To enable client-side message translation, use a unique message ID for the message argument.
    
    Parameters:
    
    message - The message to return to the client.
  - AdapterException
```
public AdapterException(java.lang.Throwable cause)
```
    Constructs a new AdapterException with the given cause.
    
    Parameters:
    
    cause - The cause of the AdapterException.
  - AdapterException
```
public AdapterException(java.lang.String message,
                java.lang.Throwable cause)
```
    Constructs a new AdapterException with the given message and cause.
    
    Parameters:
    
    message - The message to return to the client.
    
    cause - The cause of the AdapterException.

Class AdapterException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

INVALID_USERNAME

INVALID_RESOURCE_ID

INVALID_QUERY_PARAM

ERR_NOT_LOGGED_IN

ERR_NOT_AUTHORIZED

ERR_NO_ADMIN_SET

ERR_RETRIEVE_REVIEW

ERR_DUPLICATE_REVIEW

ERR_CREATE_REVIEW

ERR_REVIEW_INVALID_ITEM_HANDLE

ERR_REVIEW_INVALID_USER_ID

ERR_TIMEOUT

DUPLICATE_RECOMMENDATION

ERR_CONNECT_SERVICE

ERR_PHOTO_UPLOAD_FAILED

ERR_INVALID_PAGE_SIZE

ERR_INVALID_PAGE_NUMBER

ERR_CREATE_ENTRY

ERROR_RETRIEVING_BLOG

ERR_RETRIEVE_ENTRY

ERROR_RETRIEVING_MEDIA

ERR_DELETE_ENTRY

ERR_FLAG_ENTRY

ERR_CREATE_COMMENT

ERR_RETRIEVE_COMMENT

ERR_RETRIEVE_PROFILE

ERR_PROFILE_INVALID_USER_ID

ERR_CREATE_PROFILE

ERR_UPDATE_PROFILE

ERROR_CREATING_UPDATING_PROFILE

ERR_FETCHING_PROFILE

ERR_PROFILE_UNAUTHORIZED

ERR_CREATE_BLOG

ERR_SHARE_IT_BLOG

OAUTH_TIMESTAMP_ERROR

Constructor Detail

AdapterException

AdapterException

AdapterException