Skip to main content

Streamlining the Core Service Java Client

Image
By
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


Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
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...
2 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...
10 comments
Read more