org.ops4j.pax.swissbox.tinybundles.dp
Interface TinyDP

All Known Implementing Classes:
TinyDPImpl

public interface TinyDP

Humane API for constructing Deployment Packages. Capabilities and final format will comply to OSGi Compendium R4 Version 4.2, Deployment Admin Specification Version 1.1

Since:
May 23, 2009
Author:
Toni Menzel (toni@okidokiteam.com)

Method Summary
 java.io.InputStream build()
           
 TinyDP remove(java.lang.String identifier)
           
 TinyDP set(java.lang.String key, java.lang.String value)
          Meta Data that will appear in the Main Section of this DP Meta Inf Manifest
 TinyDP setBundle(java.lang.String name, java.io.InputStream inp)
          the very basic way to add a bundle.
 TinyDP setBundle(java.lang.String name, java.lang.String url)
          convenient adapter for setBundle(String,InputStream)
 TinyDP setBundle(java.lang.String name, TinyBundle inp)
          convinient adapter for setBundle(String,InputStream)
 TinyDP setResource(java.lang.String name, java.io.InputStream inp)
           
 TinyDP setResource(java.lang.String name, java.lang.String url)
           
 TinyDP setSymbolicName(java.lang.String value)
          Shortcut for set( Constants.DEPLOYMENTPACKAGE_SYMBOLICMAME, value )
 TinyDP setVersion(java.lang.String value)
          Shortcut for set( Constants.DEPLOYMENTPACKAGE_VERSION, value )
 

Method Detail

set

TinyDP set(java.lang.String key,
           java.lang.String value)
Meta Data that will appear in the Main Section of this DP Meta Inf Manifest

Parameters:
key - to be used
value - to be used
Returns:
this

setSymbolicName

TinyDP setSymbolicName(java.lang.String value)
Shortcut for set( Constants.DEPLOYMENTPACKAGE_SYMBOLICMAME, value )

Parameters:
value - to be used
Returns:
this

setVersion

TinyDP setVersion(java.lang.String value)
Shortcut for set( Constants.DEPLOYMENTPACKAGE_VERSION, value )

Parameters:
value - to be used
Returns:
this

setResource

TinyDP setResource(java.lang.String name,
                   java.io.InputStream inp)
                   throws java.io.IOException
Throws:
java.io.IOException

setResource

TinyDP setResource(java.lang.String name,
                   java.lang.String url)
                   throws java.io.IOException
Throws:
java.io.IOException

build

java.io.InputStream build()
                          throws java.io.IOException
Throws:
java.io.IOException

remove

TinyDP remove(java.lang.String identifier)

setBundle

TinyDP setBundle(java.lang.String name,
                 TinyBundle inp)
                 throws java.io.IOException
convinient adapter for setBundle(String,InputStream)

Parameters:
name - identifier of Name parameter in DP manifest
inp - content of this resource
Returns:
this (fluent api)
Throws:
java.io.IOException - in case of an IO error when processing inp

setBundle

TinyDP setBundle(java.lang.String name,
                 java.lang.String url)
                 throws java.io.IOException
convenient adapter for setBundle(String,InputStream)

Parameters:
name - identifier of Name parameter in DP manifest
url - content of this resource
Returns:
this (fluent api)
Throws:
java.io.IOException - if something goes wrong while interpreting the url

setBundle

TinyDP setBundle(java.lang.String name,
                 java.io.InputStream inp)
                 throws java.io.IOException
the very basic way to add a bundle.

Parameters:
name - identifier of Name parameter in DP manifest
inp - content of this resource
Returns:
this
Throws:
java.io.IOException - in case of an IO error when processing inp


Copyright © 2006-2012 OPS4J - Open Participation Software for Java. All Rights Reserved.