Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "CardSync Service 1.1"
m (→Deployer Perspective) |
(→Update higgins configuration) |
||
(12 intermediate revisions by the same user not shown) | |||
Line 12: | Line 12: | ||
== End-User Perspective == | == End-User Perspective == | ||
+ | CardSync exposes the following web services: | ||
+ | * CardSync end point: | ||
+ | ** REST WS [http://higgins.eclipse.org:3001/cardsync-new/rs/application.wadl http://higgins.eclipse.org:3001/cardsync-new/rs/application.wadl] | ||
+ | ** SOAP WS [http://higgins.eclipse.org:3001/cardsync-new/ws/CardSync http://higgins.eclipse.org:3001/cardsync-new/ws/CardSync] | ||
+ | * RPPS end point: | ||
+ | ** Service [https://higgins.eclipse.org:3001/cardsync-new/services https://higgins.eclipse.org:3001/cardsync-new/services] | ||
+ | ** WSDL [https://higgins.eclipse.org:3001/cardsync-new/services/RPPSServiceAIRICM?wsdl https://higgins.eclipse.org:3001/cardsync-new/services/RPPSServiceAIRICM?wsdl] | ||
+ | * Admin Console end point [https://higgins.eclipse.org:3001/cardsync-new/AdminWS https://higgins.eclipse.org:3001/cardsync-new/AdminWS] | ||
+ | |||
+ | Also you can find some additional documentation that is related to CardSync Data Transfer Objects at the following location: | ||
+ | [http://wiki.eclipse.org/CardSync_Data_Transfer_Objects CardSync Data Transfer Objects] | ||
== Deployer Perspective == | == Deployer Perspective == | ||
− | |||
− | |||
=== Update higgins configuration === | === Update higgins configuration === | ||
− | + | Download example configuration (LINK will be updated soon) and update DB and path settings. It depends on user home, you may change it by passing user.home parameter to JVM, like -Duser.home="/usr/share/higgins" . | |
− | Download example configuration | + | |
Update the following context settings: | Update the following context settings: | ||
* Update CardSync settings in context.xml; | * Update CardSync settings in context.xml; | ||
− | |||
* Update absolute path in .higgins/**/*.* ; | * Update absolute path in .higgins/**/*.* ; | ||
* Update sts client configuration ConfigurationFile/ClientConfiguration.xml (at least keystore file, certificate/key settings). | * Update sts client configuration ConfigurationFile/ClientConfiguration.xml (at least keystore file, certificate/key settings). | ||
Line 29: | Line 36: | ||
CardSync use the following system properties (please, add them to your web server configuration ): | CardSync use the following system properties (please, add them to your web server configuration ): | ||
* STS configuration directory for example: | * STS configuration directory for example: | ||
− | + | -Dorg.eclipse.higgins.sts.conf=/usr/share/higgins/ConfigurationFile | |
* Trust store file, for example : | * Trust store file, for example : | ||
− | + | -Djavax.net.ssl.trustStore=/usr/share/higgins/.keystore | |
* Directory which contains native key generator (liborg.eclipse.higgins.util.openssl.impl.so), for example: | * Directory which contains native key generator (liborg.eclipse.higgins.util.openssl.impl.so), for example: | ||
− | + | -Djava.library.path=/usr/share/higgins/native/ | |
* Higgins configuration suppose to find .higgins in user home, but you may change it by using user.home property, for example: | * Higgins configuration suppose to find .higgins in user home, but you may change it by using user.home property, for example: | ||
− | + | -Duser.home="/usr/share/higgins" | |
+ | |||
+ | === Update web context configuration === | ||
+ | Update the following context settings: | ||
+ | |||
+ | Cache | ||
+ | <Parameter name="CacheConfigurationBase" value="/usr/share/higgins/cache" /> | ||
+ | <Parameter name="CacheConfigurationFile" value="CacheConfiguration.xml" /> | ||
+ | |||
+ | Login and UserProfile Services configuration | ||
+ | <Environment name="HigginsConfigurationBase" value="/usr/share/higgins" | ||
+ | type="java.lang.String" override="false" /> | ||
+ | <Environment name="HigginsConfigurationFile" value="User.xml" | ||
+ | type="java.lang.String" override="false" /> | ||
+ | <Environment name="AccessTokenMaxIdleTime" value="1800" | ||
+ | type="java.lang.String" override="false" /> | ||
+ | <Environment name="AccessTokenMaxLifeTime" value="86400" | ||
+ | type="java.lang.String" override="false" /> | ||
+ | <Environment name="AuthServiceEhcacheCnfUrl" value="/usr/share/higgi/cach/ehcache.xml" | ||
+ | type="java.lang.String" override="false" /> | ||
+ | <Resource name="cardsync/ResourceMetaDataService" auth="Application" | ||
+ | type="org.eclipse.higgins.sync.meta.hb.ResourceMetaDataService" | ||
+ | factory="org.apache.naming.factory.BeanFactory" /> | ||
+ | <Resource name="cardsync/AuthenticateService" auth="Application" | ||
+ | type="org.eclipse.higgins.sync.auth.ehcache.AuthenticateServiceBean" | ||
+ | factory="org.apache.naming.factory.BeanFactory" /> | ||
+ | <Resource name="rpps/cards" auth="Container" type="javax.sql.DataSource" | ||
+ | maxActive="150" maxIdle="30" maxWait="-1" removeAbandoned="true" | ||
+ | removeAbandonedTimeout="180" logAbandoned="true" username="higgins_rpps" | ||
+ | password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/higgins_TestCards?autoReconnect=true" /> | ||
+ | |||
+ | UserProfile DB settings | ||
+ | <Resource name="rpps/up" global="rpps/up" auth="Container" | ||
+ | type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" | ||
+ | driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/higgins_up_rh156?autoReconnect=true& | ||
+ | amp;useUnicode=yes&characterEncoding=UTF-8" | ||
+ | removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" | ||
+ | maxActive="200" maxIdle="50" validationQuery="Select 1" /> | ||
+ | |||
+ | CertificateStore DB settings | ||
+ | <Resource name="rpps/certstore" global="rpps/certstore" auth="Container" | ||
+ | type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" | ||
+ | driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/higgins_certstore?autoReconnect=true& | ||
+ | amp;useUnicode=yes&characterEncoding=UTF-8" | ||
+ | removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" | ||
+ | maxActive="50" maxIdle="10" validationQuery="Select 1" /> | ||
+ | |||
+ | RPkeystore DB settings | ||
+ | <Resource name="rpps/rpkeystore" global="rpps/rpkeystore" auth="Container" | ||
+ | type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" | ||
+ | driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/higgins_rp_keystore?autoReconnect=true& | ||
+ | amp;useUnicode=yes&characterEncoding=UTF-8" | ||
+ | removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" | ||
+ | maxActive="300" maxIdle="30" validationQuery="Select 1" /> | ||
+ | |||
+ | UserProfileAuditService DB settings | ||
+ | <Resource name="rpps/audit" global="rpps/audit" auth="Container" | ||
+ | type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" | ||
+ | driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/?autoReconnect=true&useUnicode=yes& | ||
+ | amp;characterEncoding=UTF-8" | ||
+ | removeAbandoned="true" removeAbandonedTimeout="60" logAbandoned="true" | ||
+ | maxActive="100" maxIdle="30" validationQuery="Select 1" /> | ||
+ | |||
+ | Hibernate based Resource Meta Data Service DB settings | ||
+ | <Resource name="cardsync/meta_hb" global="cardsync/meta_hb" | ||
+ | auth="Container" type="javax.sql.DataSource" username="higgins_cardsync" | ||
+ | password="password" driverClassName="org.gjt.mm.mysql.Driver" | ||
+ | url="jdbc:mysql://rh152.sohosmart.net/hcs_meta?autoReconnect=true& | ||
+ | amp;useUnicode=yes&characterEncoding=UTF-8" | ||
+ | maxActive="100" maxIdle="7" validationQuery="Select 1" | ||
+ | removeAbandoned="true" removeAbandonedTimeout="60" logAbandoned="true" /> | ||
+ | |||
== Developer Perspective == | == Developer Perspective == |
Latest revision as of 10:20, 21 June 2010
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
The CardSync Service is a web service that synchronizes card data between itself and one or more selector clients. Changes made on any one of a user's selectors are synchronized to all of the other of that user's selectors. CardSync Design Goals.
Contents
Version
The CardSync Service is being developed as part of Higgins 1.1.
Used By
The CardSync Service will be first used by the GTK Selector 1.1-Win solution. It is used by the Synchronizing Card Store within the Local I-Card Service.
End-User Perspective
CardSync exposes the following web services:
- CardSync end point:
- RPPS end point:
- Admin Console end point https://higgins.eclipse.org:3001/cardsync-new/AdminWS
Also you can find some additional documentation that is related to CardSync Data Transfer Objects at the following location: CardSync Data Transfer Objects
Deployer Perspective
Update higgins configuration
Download example configuration (LINK will be updated soon) and update DB and path settings. It depends on user home, you may change it by passing user.home parameter to JVM, like -Duser.home="/usr/share/higgins" .
Update the following context settings:
- Update CardSync settings in context.xml;
- Update absolute path in .higgins/**/*.* ;
- Update sts client configuration ConfigurationFile/ClientConfiguration.xml (at least keystore file, certificate/key settings).
CardSync use the following system properties (please, add them to your web server configuration ):
- STS configuration directory for example:
-Dorg.eclipse.higgins.sts.conf=/usr/share/higgins/ConfigurationFile
- Trust store file, for example :
-Djavax.net.ssl.trustStore=/usr/share/higgins/.keystore
- Directory which contains native key generator (liborg.eclipse.higgins.util.openssl.impl.so), for example:
-Djava.library.path=/usr/share/higgins/native/
- Higgins configuration suppose to find .higgins in user home, but you may change it by using user.home property, for example:
-Duser.home="/usr/share/higgins"
Update web context configuration
Update the following context settings:
Cache
<Parameter name="CacheConfigurationBase" value="/usr/share/higgins/cache" /> <Parameter name="CacheConfigurationFile" value="CacheConfiguration.xml" />
Login and UserProfile Services configuration
<Environment name="HigginsConfigurationBase" value="/usr/share/higgins" type="java.lang.String" override="false" /> <Environment name="HigginsConfigurationFile" value="User.xml" type="java.lang.String" override="false" /> <Environment name="AccessTokenMaxIdleTime" value="1800" type="java.lang.String" override="false" /> <Environment name="AccessTokenMaxLifeTime" value="86400" type="java.lang.String" override="false" /> <Environment name="AuthServiceEhcacheCnfUrl" value="/usr/share/higgi/cach/ehcache.xml" type="java.lang.String" override="false" /> <Resource name="cardsync/ResourceMetaDataService" auth="Application" type="org.eclipse.higgins.sync.meta.hb.ResourceMetaDataService" factory="org.apache.naming.factory.BeanFactory" /> <Resource name="cardsync/AuthenticateService" auth="Application" type="org.eclipse.higgins.sync.auth.ehcache.AuthenticateServiceBean" factory="org.apache.naming.factory.BeanFactory" /> <Resource name="rpps/cards" auth="Container" type="javax.sql.DataSource" maxActive="150" maxIdle="30" maxWait="-1" removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" username="higgins_rpps" password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/higgins_TestCards?autoReconnect=true" />
UserProfile DB settings
<Resource name="rpps/up" global="rpps/up" auth="Container" type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/higgins_up_rh156?autoReconnect=true& amp;useUnicode=yes&characterEncoding=UTF-8" removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" maxActive="200" maxIdle="50" validationQuery="Select 1" />
CertificateStore DB settings
<Resource name="rpps/certstore" global="rpps/certstore" auth="Container" type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/higgins_certstore?autoReconnect=true& amp;useUnicode=yes&characterEncoding=UTF-8" removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" maxActive="50" maxIdle="10" validationQuery="Select 1" />
RPkeystore DB settings
<Resource name="rpps/rpkeystore" global="rpps/rpkeystore" auth="Container" type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/higgins_rp_keystore?autoReconnect=true& amp;useUnicode=yes&characterEncoding=UTF-8" removeAbandoned="true" removeAbandonedTimeout="180" logAbandoned="true" maxActive="300" maxIdle="30" validationQuery="Select 1" />
UserProfileAuditService DB settings
<Resource name="rpps/audit" global="rpps/audit" auth="Container" type="javax.sql.DataSource" username="higgins_rpps" password="higginsRPPS" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/?autoReconnect=true&useUnicode=yes& amp;characterEncoding=UTF-8" removeAbandoned="true" removeAbandonedTimeout="60" logAbandoned="true" maxActive="100" maxIdle="30" validationQuery="Select 1" />
Hibernate based Resource Meta Data Service DB settings
<Resource name="cardsync/meta_hb" global="cardsync/meta_hb" auth="Container" type="javax.sql.DataSource" username="higgins_cardsync" password="password" driverClassName="org.gjt.mm.mysql.Driver" url="jdbc:mysql://rh152.sohosmart.net/hcs_meta?autoReconnect=true& amp;useUnicode=yes&characterEncoding=UTF-8" maxActive="100" maxIdle="7" validationQuery="Select 1" removeAbandoned="true" removeAbandonedTimeout="60" logAbandoned="true" />
Developer Perspective
Architecture
Packages:
Service
API
- CardSync JAX-RS API - RESTful API
Misc
- CardSync Authentication - RESTful API Authentication
- CardSync Exceptions - coming soon
- CardSync Data Transfer Objects - objects moving over the network