Skip to main content

Streamlining the Core Service Java Client

In a previous post (http://yatb.mitza.net/2012/12/a-core-service-java-client.html), I was presenting the Java client for Core Service. In this post, I decided to post the distributable JAR on my Google Code project page. You can find the JAR distributable [direct link] for Core Service Java client for Tridion 2011 SP1 HR1 at the following URL: https://code.google.com/p/yet-another-tridion-blog/source/browse/trunk/Core+Service+Java+Client/#Core%20Service%20Java%20Client%2Fdist

The only new feature of this distribution is the CoreServiceFactory class in package mitza.coreservice.client, which allows you to easily obtain a Core Service client object. The following methods are exposed:
  • getBasicHttpClient() - Get the singleton CoreService client for the BasicHttp endpoint;
  • getService() - Get the singleton CoreService2011 service object. This method is used internally by the get*Client methods. The logic uses a WSDL local to the JAR rather than connecting and downloading the WSDL from the remote Core Service server;

The factory also allows to specify the Core Service base URL, user name and password:
  • setDefault(String coreServiceBaseUrl) - Set the default CoreService URL. The user name and password are omitted in this case -- the currently logged in user is used implicitely;
  • setDefault(String userName, String password) - Set the default CoreService user and password. The Core Service base URL is omitted in this case -- the URL http://localhost is used implicitely
  • setDefault(String coreServiceBaseUrl, String userName, String password) - Set the default CoreService URL, user name and password;

Example: how to get a Core Service client object:

CoreServiceFactory.setDefault("http://t2011sp1hr1.playground", "administrator", "password");
ICoreService client = CoreServiceFactory.getBasicHttpClient();

The distributable contains a test class Test in package mitza.coreservice.client. The program expects 0 to 3 arguments ranging from only specifying the URL to all 3 params (URL, user name, password).

public static void main(String[] args) throws Exception {
    if (args.length == 1) { // URL
        CoreServiceFactory.setDefault(args[0]);
    } else if (args.length == 2) { // username, password
        CoreServiceFactory.setDefault(args[0], args[1]);
    } else if (args.length == 3) { // URL, username, password
        CoreServiceFactory.setDefault(args[0], args[1], args[2]);
    } else {
        CoreServiceFactory.setDefault("http://t2013.playground");
    }

    ICoreService client = CoreServiceFactory.getBasicHttpClient();

    System.out.println("Api version: " + client.getApiVersion());

    UserData currentUser = client.getCurrentUser();
    System.out.println("Current user: '" + currentUser.getTitle() + "' '" +
            currentUser.getDescription() + "' " + currentUser.getId());

    System.out.println("Publication objects:");
    PublicationsFilterData filter = new PublicationsFilterData();
    ArrayOfIdentifiableObjectData systemWideList = client.getSystemWideList(filter);
    for (IdentifiableObjectData iod : systemWideList.getIdentifiableObjectData()) {
        PublicationData publication = (PublicationData) iod;
        System.out.println("\t" + publication.getTitle());
    }

    System.out.println("Publications XML:");
    GetSystemWideListXmlResult resultXml = client.getSystemWideListXml(filter);
    Element element = (Element) resultXml.getAny();
    Utils.printDocument(element.getOwnerDocument(), System.out);
}

To run the code, one could use runtest.bat available:

set classpath=;core-service-client-2011sp1hr1.jar
java -cp %classpath% mitza.coreservice.client.Test http://localhost author tridion


Comments

Popular posts from this blog

Toolkit - Performance

This post if part of a series about the File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents performance data that was captured for each major functionality with and without caching Linking, CP Assembler, Component Presentation Factory, Dynamic Content Queries, Model Factory. The data was captured on a 2014 Macbook Pro 15", 16 GB RAM, 2.6 GHz Intel Core i7 running OS X El Capitan. Test methodology: each test was run for 3 minutes and the total number of successful Toolkit API calls was measured. Then the number of calls per second was computed 'with cache' and 'without cache' test runs. Then a cache boost factor was calculated by diving (the number of API calls with cache) / (number of API calls without cache). Each cache test was executed 3 times, with different cache time-to-live values of 1 second, 5 seconds and 0 seconds (eternal cache, no expiration). The rationale is to see what impact different cache expiration/evi...

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as...

A Core Service Java Client

I have seen many times the creation of a .NET client for SDL Tridion's Core Service, but not once a Java client. In .NET / Visual Studio is extremely easy to create the proxy classes based on the service's WSDL. So how hard can it be in Java? The entire code in this example is available in my Google Code project . Which Tool? Doing a bit of research on the multiple ways of creating Java proxy classes for web services left me quite confused as to which framework / utility to use. They are quite a few (AXIS, JAXB, Apache CXF, XFire, NetBeans plugin, IDEA plugin, Eclipse plugin, etc). They seemed to be cumbersome to use, too specific, limited, quirky, buggy, etc. What I wanted was a simple generic too that worked. Enter wsimport.exe ... Generating the Proxies Note: Check out the update post available here  http://yatb.mitza.net/2012/12/java-core-service-trouble-with-datetime.html Wsimport.exe is part of the JDK (mine is located in C:\Progrm Files\Java\jdk1.6.0_33\bin ),...