org.ops4j.pax.runner.platform
Interface PlatformBuilder

All Known Implementing Classes:
ConciergePlatformBuilder, ConciergePlatformBuilderSnapshot, EquinoxPlatformBuilder, EquinoxPlatformBuilderSnapshot, FelixPlatformBuilderF100T122, FelixPlatformBuilderF140T141, FelixPlatformBuilderF160, FelixPlatformBuilderSnapshot, KnopflerfishPlatformBuilderF200T233, KnopflerfishPlatformBuilderF300, KnopflerfishPlatformBuilderSnapshot

public interface PlatformBuilder

Callback methods for platform specific actions.

Since:
August 20, 2007
Author:
Alin Dreghiciu

Method Summary
 java.lang.String[] getArguments(PlatformContext context)
          Returns an array of platform specific startup arguments.
 java.io.InputStream getDefinition(Configuration configuration)
          Retuns an input stream out of the definition file to be used.
 java.lang.String getMainClassName()
          Returns the name of the main class of the platform, class that will be used to fire up the platform.
 java.lang.String getProviderName()
          Returns the name of the provider (e.g.
 java.lang.String getProviderVersion()
          Returns the version of the provider (e.g.
 java.lang.String getRequiredProfile(PlatformContext context)
          Returns a comma separated list of profiles if required by platform or null if no profile is required.
 java.lang.String[] getVMOptions(PlatformContext context)
          Returns an array of virtual machine options specific to platform as -D.
 void prepare(PlatformContext context)
          Prepares platform for running.
 

Method Detail

prepare

void prepare(PlatformContext context)
             throws PlatformException
Prepares platform for running. Specific tasks could include creating of configuration files for platform, ...

Parameters:
context - context information
Throws:
PlatformException - if something goes wrong durring building the platform

getMainClassName

java.lang.String getMainClassName()
Returns the name of the main class of the platform, class that will be used to fire up the platform.

Returns:
main class name

getArguments

java.lang.String[] getArguments(PlatformContext context)
Returns an array of platform specific startup arguments. This are appended to the startup command.

Parameters:
context - context information
Returns:
an array of arguments

getVMOptions

java.lang.String[] getVMOptions(PlatformContext context)
Returns an array of virtual machine options specific to platform as -D.

Parameters:
context - context information
Returns:
an array of system properties

getDefinition

java.io.InputStream getDefinition(Configuration configuration)
                                  throws java.io.IOException
Retuns an input stream out of the definition file to be used.

Parameters:
configuration -
Returns:
an input stream
Throws:
java.io.IOException - if the input stream could not be opened.

getRequiredProfile

java.lang.String getRequiredProfile(PlatformContext context)
Returns a comma separated list of profiles if required by platform or null if no profile is required.

Parameters:
context - context information
Returns:
a comma separated list of profiles

getProviderName

java.lang.String getProviderName()
Returns the name of the provider (e.g. felix, equionox)

Returns:
name of the provider

getProviderVersion

java.lang.String getProviderVersion()
Returns the version of the provider (e.g. 1.0, 3.3.0)

Returns:
version of the provider


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