Difference between revisions of "GVSocialAdapter-Configuration"
Line 7: | Line 7: | ||
social="twitter" type="social-adapter"> | social="twitter" type="social-adapter"> | ||
<Accounts> | <Accounts> | ||
− | <Account name=" | + | <Account name="ACCOUNT_NAME" consumer_key="..." consumer_secret="..." oauth_access_token="..." oauth_access_token_secret="..." twitteruserid="..."/> |
... | ... | ||
</Accounts> | </Accounts> | ||
Line 17: | Line 17: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
+ | The XML above shows the configuration for [http://twitter.com Twitter] platform | ||
The following table explains the configuration: | The following table explains the configuration: | ||
{|class="gvtable" | {|class="gvtable" | ||
Line 62: | Line 63: | ||
* the user's credentials are not spread, the application has its own tokens | * the user's credentials are not spread, the application has its own tokens | ||
All the tokens are specified into the configuration file for each account. | All the tokens are specified into the configuration file for each account. | ||
+ | |||
+ | The messages exchanged with the adapter have the following format: | ||
+ | |||
+ | * Request: | ||
+ | <syntaxhighlight lang="xml"> | ||
+ | <SocialService> | ||
+ | <updateStatus account="ACCOUNT_NAME"> | ||
+ | <attribute type="java.lang.String">Message to publish</attribute> | ||
+ | </updateStatus> | ||
+ | </SocialService> | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | *Response: | ||
+ | <syntaxhighlight lang="xml"> | ||
+ | <SocialServiceResponse> | ||
+ | <updateStatus account="ACCOUNT_NAME"> | ||
+ | <result type="java.lang.String">OK</attribute> | ||
+ | <error></error> | ||
+ | </updateStatus> | ||
+ | <flagGlobalErrors/> | ||
+ | </SocialServiceResponse> | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | The tag '''updateStatus''' in the XML above is referred to an operation available in Twitter, more exactly is the one called to send a tweet. Each operation available for a Social platform has its own XML tag and parameters, and it is presented in [[{{VULCON}}]] allowing to define data transformation. |
Revision as of 10:26, 21 September 2012
The Social adapter is an adapter which gives GreenVulcano® ESB the ability to interact with social platforms. The configuration is specified into the GVSocialAdapter-Configuration.xml, and the file has the following structure:
<GVSocialAdapterManager name="GV_SOCIAL" type="module">
<SocialAdapters>
<TwitterSocialAdapter class="it.greenvulcano.gvesb.....TwitterSocialAdapter"
social="twitter" type="social-adapter">
<Accounts>
<Account name="ACCOUNT_NAME" consumer_key="..." consumer_secret="..." oauth_access_token="..." oauth_access_token_secret="..." twitteruserid="..."/>
...
</Accounts>
...
<Proxy proxyHost="" proxyPassword="" proxyPort="" proxyUser=""/>
</TwitterSocialAdapter>
</SocialAdapters>
</GVSocialAdapterManager>
The XML above shows the configuration for Twitter platform The following table explains the configuration:
Parameter | Meaning and values |
---|---|
TwitterSocialAdapter | One of the implemented adapters |
TwitterSocialAdapter class | the adapter class |
TwitterSocialAdapter social | the social platform identifier |
TwitterSocialAdapter type | the adapter type |
Accounts | wrapper for all the account configured for a single social platform |
Account | single account configuration |
Account name | the name identifying the account |
Account consumer_key | OAuth parameter |
Account consumer_secret | OAuth parameter |
Account access_token | OAuth parameter |
Account access_token_secret | OAuth parameter |
Account twitteruserid | user id on the social platform |
Proxy | proxy settings |
Proxy proxyHost | proxy host |
Proxy proxyPort | proxy port |
Proxy proxyUser | user for the proxy |
Proxy proxyPassword | password for the proxy |
Social platforms use the OAuth to achieve the following goals:
- a user can control which permissions he/she can grant to the installed application
- a user can revoke such permissions at any time
- the user's credentials are not spread, the application has its own tokens
All the tokens are specified into the configuration file for each account.
The messages exchanged with the adapter have the following format:
- Request:
<SocialService>
<updateStatus account="ACCOUNT_NAME">
<attribute type="java.lang.String">Message to publish</attribute>
</updateStatus>
</SocialService>
- Response:
<SocialServiceResponse>
<updateStatus account="ACCOUNT_NAME">
<result type="java.lang.String">OK</attribute>
<error></error>
</updateStatus>
<flagGlobalErrors/>
</SocialServiceResponse>
The tag updateStatus in the XML above is referred to an operation available in Twitter, more exactly is the one called to send a tweet. Each operation available for a Social platform has its own XML tag and parameters, and it is presented in VulCon allowing to define data transformation.