On behalf of Elvanor ( a in the process New Developer ) I would like to
present the osgi.eclass.
What is OSGi, well....
Copied directly from wikipedia [1]
"The Framework implements a complete and dynamic component model,
something that is missing in standalone Java/VM environments.
Applications or components (coming in the form of bundles for
deployment) can be remotely installed, started, stopped, updated and
uninstalled without requiring a reboot; management of Java
packages/classes is specified in great detail. Life cycle management is
done via APIs which allow for remote downloading of management policies.
The service registry allows bundles to detect the addition of new
services, or the removal of services, and adapt accordingly."
Basically and for all the purposes that you will care about, the eclass
adds information to a jar's Manifest file that can then be used by the
OSGi framework ( aka currently eclipse ). Without this functionality we
will not be able to use system jars for our eclipse package.
you may find an example ebuild that uses the osgi class at
http://overlays.gentoo.org/svn/proj/java/java-experimental/dev-java/swt/swt-3.3-r1.ebuild
and the eclass is attached and located at
http://overlays.gentoo.org/svn/proj/java/java-experimental/eclass/osgi.eclass
Im sure Elvanor can't wait for you constructive feedback on his eclass
and depending on your feedback the eclass will enter the tree this weekend.
ali_bush
[1] http://en.wikipedia.org/wiki/OSGi
# Base eclass for Java packages that needs to be OSGi compliant
#
# Copyright (c) 2007, Jean-Noël Rivasseau <[EMAIL PROTECTED]>
# Copyright (c) 2007, Gentoo Foundation
#
# Licensed under the GNU General Public License, v2
#
# $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.92 2007/08/05
08:17:05 betelgeuse Exp $
# -----------------------------------------------------------------------------
# @eclass-begin
# @eclass-shortdesc Java OSGi eclass
# @eclass-maintainer [EMAIL PROTECTED]
#
# This eclass provides functionality which is used by
# packages that need to be OSGi compliant. This means
# that the generated jars will have special headers in their manifests.
# Currently this is used only by Eclipse-3.3 - later
# we could extend this so that Gentoo Java system would be
# fully OSGi compliant.
#
# -----------------------------------------------------------------------------
inherit java-utils-2
# We define _OSGI_T so that it does not contain a slash at the end.
# According to Paludis guys, there is currently a proposal for EAPIs that
# would require all variables to end with a slash.
_OSGI_T="${T/%\//}"
# -----------------------------------------------------------------------------
# @ebuild-function _java-pkg_osgi-plugin
#
# This is an internal function, not to be called directly.
#
# @example
# _java-pkg_osgi-plugin "JSch"
#
# @param $1 - bundle name
#
# ------------------------------------------------------------------------------
_java-pkg_osgi-plugin() {
# We hardcode Gentoo as the vendor name
cat > "${_OSGI_T}/tmp_jar/plugin.properties" <<-EOF
bundleName=${1}
vendorName=Gentoo
EOF
}
# -----------------------------------------------------------------------------
# @ebuild-function _java-pkg_osgijar
#
# This is an internal function, not to be called directly.
#
# @example
# _java-pkg_osgijar "dist/${PN}.jar" "com.jcraft.jsch" "com.jcraft.jsch,
com.jcraft.jsch.jce;x-internal:=true" "JSch"
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 - bundle symbolic name
# @param $3 - export-package-header
# @param $4 - bundle name
#
# ------------------------------------------------------------------------------
_java-pkg_osgijar() {
debug-print-function ${FUNCNAME} $*
[[ ${#} -lt 4 ]] && die "At least four arguments needed"
mkdir "${_OSGI_T}/tmp_jar" || die "Unable to create directory
${_OSGI_T}/tmp_jar"
[[ -d "${_OSGI_T}/osgi" ]] || mkdir "${_OSGI_T}/osgi" || die "Unable to
create directory ${_OSGI_T}/osgi"
local jar_name="$(basename $1)"
cp "$1" "${_OSGI_T}/tmp_jar" && pushd "${_OSGI_T}/tmp_jar" > /dev/null
jar xf "${jar_name}" && rm "${jar_name}" && popd > /dev/null || die
"Unable to uncompress correctly the original jar"
cat > "${_OSGI_T}/tmp_jar/META-INF/MANIFEST.MF" <<-EOF
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %bundleName
Bundle-Vendor: %vendorName
Bundle-Localization: plugin
Bundle-SymbolicName: ${2}
Bundle-Version: ${PV}
Export-Package: ${3}
EOF
_java-pkg_osgi-plugin ${4}
jar cfm "${_OSGI_T}/osgi/${jar_name}"
"${_OSGI_T}/tmp_jar/META-INF/MANIFEST.MF" \
-C "${_OSGI_T}/tmp_jar/" . > /dev/null || die "Unable to
recreate the OSGi compliant jar"
rm -rf "${_OSGI_T}/tmp_jar"
}
# -----------------------------------------------------------------------------
# @ebuild-function java-pkg_doosgijar
#
# Rewrites a jar, and produce an OSGi compliant jar from arguments given on the
command line.
# The arguments given correspond to the minimal set of headers
# that must be present on a Manifest file of an OSGi package.
# If you need more headers, you should use the *-fromfile functions below,
# that create the Manifest from a file.
# It will call java-pkg_dojar at the end.
#
# @example
# java-pkg_doosgijar "dist/${PN}.jar" "com.jcraft.jsch" "com.jcraft.jsch,
com.jcraft.jsch.jce;x-internal:=true" "JSch"
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 - bundle symbolic name
# @param $3 - export-package-header
# @param $4 - bundle name
#
# ------------------------------------------------------------------------------
java-pkg_doosgijar() {
debug-print-function ${FUNCNAME} $*
local jar_name="$(basename $1)"
_java-pkg_osgijar "$@"
java-pkg_dojar "${_OSGI_T}/osgi/${jar_name}"
}
# -----------------------------------------------------------------------------
# @ebuild-function java-pkg_newosgijar
#
# Rewrites a jar, and produce an OSGi compliant jar.
# The arguments given correspond to the minimal set of headers
# that must be present on a Manifest file of an OSGi package.
# If you need more headers, you should use the *-fromfile functions below,
# that create the Manifest from a file.
# It will call java-pkg_newjar at the end.
#
# @example
# java-pkg_newosgijar "dist/${PN}.jar" "com.jcraft.jsch"
"com.jcraft.jsch, com.jcraft.jsch.jce;x-internal:=true" "JSch"
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 (optional) - name of the target jar. It will default to package
name if not specified.
# @param $3 - bundle symbolic name
# @param $4 - export-package-header
# @param $5 - bundle name
#
# ------------------------------------------------------------------------------
java-pkg_newosgijar() {
debug-print-function ${FUNCNAME} $*
local jar_name="$(basename $1)"
if [[ ${#} > 4 ]]; then
local newName="$2"
local arguments=("$@")
unset arguments[1]
_java-pkg_osgijar "[EMAIL PROTECTED]"
java-pkg_newjar "${_OSGI_T}/osgi/${jar_name}" "${newName}"
else
_java-pkg_osgijar "$@"
java-pkg_newjar "${_OSGI_T}/osgi/${jar_name}"
fi
}
# -----------------------------------------------------------------------------
# @ebuild-function _java-pkg_osgijar-fromfile
#
# This is an internal function, not to be called directly.
#
# @example
# _java-pkg_osgijar-fromfile "dist/${PN}.jar" "${FILESDIR}/MANIFEST.MF"
"JSch" --noversion
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 - path to the Manifest file
# @param $3 - bundle name
# --noversion This option disables automatic rewriting of the version in the
Manifest file
#
# ------------------------------------------------------------------------------
_java-pkg_osgijar-fromfile() {
debug-print-function ${FUNCNAME} $*
local counter=0
local noversion=0
while [[ -n "${1}" ]]; do
if [[ "${1}" == "--noversion" ]]; then
noversion=1
else
arguments[${counter}]="${1}"
((++counter))
fi
shift 1
done
(([EMAIL PROTECTED] < 3)) && die "At least three arguments (not
counting --noversion) are needed for java-pkg_osgijar-fromfile()"
mkdir "${_OSGI_T}/tmp_jar" || die "Unable to create directory
${_OSGI_T}/tmp_jar"
[[ -d "${_OSGI_T}/osgi" ]] || mkdir "${_OSGI_T}/osgi" || die "Unable to
create directory ${_OSGI_T}/osgi"
local jar_name="$(basename ${arguments[0]})"
cp "${arguments[0]}" "${_OSGI_T}/tmp_jar" && pushd "${_OSGI_T}/tmp_jar"
> /dev/null
jar xf "${jar_name}" && rm "${jar_name}" && popd > /dev/null || die
"Unable to uncompress correctly the original jar"
# We automatically change the version unless --noversion is present
[[ -e "${arguments[1]}" ]] || die "Manifest file ${arguments[1]} not
found"
if [[ "${noversion}" == 1 ]]; then
cat "${arguments[1]}" >
"${_OSGI_T}/tmp_jar/META-INF/MANIFEST.MF"
else
cat "${arguments[1]}" | sed
"s/Bundle-Version:.*/Bundle-Version: ${PV}/" > \
"${_OSGI_T}/tmp_jar/META-INF/MANIFEST.MF"
fi
_java-pkg_osgi-plugin "${arguments[2]}"
jar cfm "${_OSGI_T}/osgi/${jar_name}"
"${_OSGI_T}/tmp_jar/META-INF/MANIFEST.MF" \
-C "${_OSGI_T}/tmp_jar/" . > /dev/null || die "Unable to
recreate the OSGi compliant jar"
rm -rf "${_OSGI_T}/tmp_jar"
}
# -----------------------------------------------------------------------------
# @ebuild-function java-pkg_newosgijar-fromfile()
#
# This function produces an OSGi compliant jar from a given manifest file.
# The Manifest Bundle-Version header will be replaced by the current version
# of the package, unless the --noversion argument is given.
# It will call java-pkg_newjar at the end.
#
# @example
# java-pkg_newosgijar "dist/${PN}.jar" "${FILESDIR}/MANIFEST.MF"
"Standard Widget Toolkit for GTK 2.0"
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 (optional) - name of the target jar. It will default to package
name if not specified.
# @param $3 - path to the Manifest file
# @param $4 - bundle name
# --noversion This option disables automatic rewriting of the version in the
Manifest file
#
# ------------------------------------------------------------------------------
java-pkg_newosgijar-fromfile() {
debug-print-function ${FUNCNAME} $*
local jar_name="$(basename $1)"
if [[ ${#} > 3 ]]; then
local newName="$2"
local arguments=("$@")
unset arguments[1]
_java-pkg_osgijar-fromfile "[EMAIL PROTECTED]"
java-pkg_newjar "${_OSGI_T}/osgi/${jar_name}" "${newName}"
else
_java-pkg_osgijar-fromfile "$@"
java-pkg_newjar "${_OSGI_T}/osgi/${jar_name}"
fi
}
# -----------------------------------------------------------------------------
# @ebuild-function java-pkg_doosgijar-fromfile()
#
# This function produces an OSGi compliant jar from a given manifestfile.
# The Manifest Bundle-Version header will be replaced by the current version
# of the package, unless the --noversion argument is given.
# It will call java-pkg_dojar at the end.
#
# @example
# java-pkg_doosgijar "dist/${PN}.jar" "${FILESDIR}/MANIFEST.MF" "Standard
Widget Toolkit for GTK 2.0"
#
# @param $1 - name of jar to repackage with OSGi
# @param $2 - path to the Manifest file
# @param $3 - bundle name
# --noversion This option disables automatic rewriting of the version in the
Manifest file
#
# ------------------------------------------------------------------------------
java-pkg_doosgijar-fromfile() {
debug-print-function ${FUNCNAME} $*
local jar_name="$(basename $1)"
_java-pkg_osgijar-fromfile "$@"
java-pkg_dojar "${_OSGI_T}/osgi/${jar_name}"
}
