Skip to main content

Create Multimedia Component using Core Service Java Client

I recently stumbled upon the following question on TREX: http://tridion.stackexchange.com/questions/1379/not-able-to-upload-binary-images-using-core-service2011-api-from-java-client/

I had never actually attempted to upload a Binary and create a Multimedia Component using the Core Service. So I was intrigued how to achieve that.

The solution is pretty straightforward, but it does contain two steps:
  • First, upload the Binary to the TCM;
  • Second, create the Multimedia Component referencing the path on TCM where the binary had been uploaded;
The sample code below accomplishes the first step:

private static File uploadFile(File file) {
    try {
        byte[] fileData = new byte[(int) file.length()];
        DataInputStream dis = new DataInputStream(new FileInputStream(file));
        dis.readFully(fileData);
        dis.close();
        IStreamUpload clientUpload =
                CoreServiceFactory.getStreamUploadBasicHttpClientClient();
        String uploadFile = clientUpload.uploadBinaryByteArray(file.getName(), fileData);
        return new File(uploadFile);
    } catch (Exception e) {
        e.printStackTrace();
    }
    return null;
}

The method takes a local file (i.e. local on the client machine) and uploads it to the TCM using the Core Service StreamUploadBasicHttpClient endpoint. It returns a File object representing the location of the uploaded binary on the TCM (e.g. C:\Windows\TEMP\tmp2432.jpg).

Once we have the binary uploaded to the remote TCM, we can now create the Multimedia Component:

    ICoreService client = CoreServiceFactory.getBasicHttpClient();

    ReadOptions readOptions = new ReadOptions();
    ComponentData componentData = (ComponentData) client.getDefaultData(ItemType.COMPONENT, "tcm:1-1-2"readOptions);
    componentData.setTitle("MMC " + System.currentTimeMillis());

    LinkToSchemaData linkToSchema = new LinkToSchemaData();
    linkToSchema.setIdRef("tcm:1-26-8");
    componentData.setSchema(linkToSchema);

    File localFile = new File("C:\\Beagle.jpg");
    File remoteFile = uploadFile(localFile);
    BinaryContentData binaryContentData = new BinaryContentData();
    binaryContentData.setFilename(localFile.getName());
    binaryContentData.setUploadFromFile(remoteFile.getAbsolutePath());

    LinkToMultimediaTypeData linkToMultimediaType = new LinkToMultimediaTypeData();
    linkToMultimediaType.setIdRef("tcm:0-2-65544");
    binaryContentData.setMultimediaType(linkToMultimediaType);
    componentData.setBinaryContent(binaryContentData);

    componentData = (ComponentData) client.save(componentData, readOptions);
    client.checkIn(componentData.getId(), true, null, readOptions);
}

The code is pretty straight forward:
  • initial ComponentData is created using client.getDefaultData();
  • Multimedia Schema is linked from ComponentData;
  • BinaryContentData is created using the remote binary file;
  • MultimediaType is identified and specified. This is probably the ugliest part of the entire appraoch. This logic could be written by first reading all available Multimedia Types, then identifying the one we need by matching on the binary mime type;

For more information about the CoreServiceFactory object, have a look at me previous posts relating to Java Core Service clients.

Note that the default Reader Quota for my Java client was 16384 bytes, and I got the following error message:

com.sun.xml.ws.fault.ServerSOAPFaultException: Client received SOAP Fault from server: The formatter threw an exception while trying to deserialize the message: Error in deserializing body of request message for operation 'UploadBinaryByteArray'. The maximum array length quota (16384) has been exceeded while reading XML data. This quota may be increased by changing the MaxArrayLength property on the XmlDictionaryReaderQuotas object used when creating the XML reader. Line 1, position 615.

The solution was to increase the MaxArrayLength reader quota on the WCF service by editing the file [TRIDION_HOME]\webservices\Web.config and to insert the following line below system.ServiceModel / bindings / basicHttpBinding / binding name="StreamUpload_basicHttpBinding":

<readerQuotas maxArrayLength="999999999" />


Comments

Jeremy Rambo said…
Did you ever figure out a way to overcome the quota issue without changing the WCF service? I.E. Can I configure the Java Client in any way that allows me to configure the maxArrayLength?
D .Deepak said…
hi..How Can we update the existing binary/multimdeia component?

Popular posts from this blog

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...

REL Standard Tag Library

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...

Publish Binaries to Mapped Structure Groups

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...