diff options
Diffstat (limited to 'udkapi/com/sun/star/loader')
| -rw-r--r-- | udkapi/com/sun/star/loader/CannotActivateFactoryException.idl | 62 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/Dynamic.idl | 67 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/Java.idl | 66 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/Java2.idl | 51 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/SharedLibrary.idl | 64 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/XImplementationLoader.idl | 123 | ||||
| -rw-r--r-- | udkapi/com/sun/star/loader/makefile.mk | 51 |
7 files changed, 484 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl new file mode 100644 index 000000000000..aaae21e4234f --- /dev/null +++ b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl @@ -0,0 +1,62 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_CannotActivateFactoryException_idl__ +#define __com_sun_star_loader_CannotActivateFactoryException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module loader { + +//============================================================================= + +/** indicates an error during component activation + <p> This exception is thrown when an application tries to + activate a component factory using the + <member>XImplementationLoader::activate()</member> + method, but the component factory can not be activated. + <p> + Possible reasons for this error is a missing shared library or .jar file, + a badly linked library, a wrong LD_LIBRARY_PATH or PATH, an incomplete + classpath, or a missing java installation. The Message should + contain some more detailed explanations. + */ +published exception CannotActivateFactoryException: com::sun::star::uno::Exception +{ +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/loader/Dynamic.idl b/udkapi/com/sun/star/loader/Dynamic.idl new file mode 100644 index 000000000000..800064c3050b --- /dev/null +++ b/udkapi/com/sun/star/loader/Dynamic.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_SharedLibrary_idl__ +#define __com_sun_star_loader_SharedLibrary_idl__ + +#ifndef __com_sun_star_lang_XServiceInfo_idl_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +module com { module sun { module star { module loader { + + published interface XImplementationLoader; + + +/** makes it possible to access services accessible via a <code>UnoUrlResolver</code> + E.g., instantiation of services in another process. This service is still in an + experimental state and should not be used in a production environment. + */ +published service Dynamic +{ + /** is used to write persistent information into the given registry + for accessing a <code>SingleServiceFactory</code> and for activating this + implementation. + */ + /** allows registration and activation of described service. + The url parameter has to be a comma-separated list of attributes. + The following attribute types are understood: + servicename = the service name to register this component under + link = a parameter given to a resolver to get a <code>SingleServiceFactory</code> + resolver = a <code>UnoUrlResolver</code> service, which is used to resolve the link + */ + interface XImplementationLoader; + + + /** gives information about other supported services + */ + interface com::sun::star::lang::XServiceInfo; +}; + +}; }; }; }; + +#endif + diff --git a/udkapi/com/sun/star/loader/Java.idl b/udkapi/com/sun/star/loader/Java.idl new file mode 100644 index 000000000000..43ca17300bfe --- /dev/null +++ b/udkapi/com/sun/star/loader/Java.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_Java_idl__ +#define __com_sun_star_loader_Java_idl__ + +#ifndef __com_sun_star_lang_XServiceInfo_idl_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + + module com { module sun { module star { module loader { + + published interface XImplementationLoader; + + +// DocMerge from xml: service com::sun::star::loader::Java +/** allows to access a java component stored with a .jar file + */ +published service Java +{ + + /** is used for writing persistent information in the registry for + external implementation and for activating this implementation. The + locationUrls must be absolute file urls. + */ + interface XImplementationLoader; + + + /** gives information about other supported services + */ + interface com::sun::star::lang::XServiceInfo; +}; + + +}; }; }; }; + +/*===================================================================== + + Source Code Control System - Update + +=====================================================================*/ +#endif + diff --git a/udkapi/com/sun/star/loader/Java2.idl b/udkapi/com/sun/star/loader/Java2.idl new file mode 100644 index 000000000000..4e0c2ff2546a --- /dev/null +++ b/udkapi/com/sun/star/loader/Java2.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_Java2_idl__ +#define __com_sun_star_loader_Java2_idl__ + +#ifndef __com_sun_star_loader_Java_idl__ +#include <com/sun/star/loader/Java.idl> +#endif + + +module com { module sun { module star { module loader { +/**the same as <type scope="com::sun::star::loader">Java</type>. +<p>This service was introduced for UNO 3 components. The then +<type scope="com::sun::star::loader">Java</type> service was intended for +UNO 2 components. Since UNO 2 is not supported anymore, the service +name is reused again. +*/ +published service Java2 +{ + service Java; + +}; + + +}; }; }; }; +#endif + diff --git a/udkapi/com/sun/star/loader/SharedLibrary.idl b/udkapi/com/sun/star/loader/SharedLibrary.idl new file mode 100644 index 000000000000..29362851cba6 --- /dev/null +++ b/udkapi/com/sun/star/loader/SharedLibrary.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_SharedLibrary_idl__ +#define __com_sun_star_loader_SharedLibrary_idl__ + +#ifndef __com_sun_star_lang_XServiceInfo_idl_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + + module com { module sun { module star { module loader { + + published interface XImplementationLoader; + + +/** allows to access a native component stored in a shared library. + */ +published service SharedLibrary +{ + + /** is used for writing persistent information in the registry for + an external implementation and for activating this + implementation. + */ + interface XImplementationLoader; + + + /** gives information about other supported services + */ + interface com::sun::star::lang::XServiceInfo; +}; + +}; }; }; }; //module com.sun.star.loader + +/*===================================================================== + + Source Code Control System - Update + +=====================================================================*/ +#endif + diff --git a/udkapi/com/sun/star/loader/XImplementationLoader.idl b/udkapi/com/sun/star/loader/XImplementationLoader.idl new file mode 100644 index 000000000000..837c31867895 --- /dev/null +++ b/udkapi/com/sun/star/loader/XImplementationLoader.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_loader_XImplementationLoader_idl__ +#define __com_sun_star_loader_XImplementationLoader_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_registry_XRegistryKey_idl__ +#include <com/sun/star/registry/XRegistryKey.idl> +#endif + +#ifndef __com_sun_star_registry_CannotRegisterImplementationException_idl__ +#include <com/sun/star/registry/CannotRegisterImplementationException.idl> +#endif + +#ifndef __com_sun_star_loader_CannotActivateFactoryException_idl__ +#include <com/sun/star/loader/CannotActivateFactoryException.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module loader { + +//============================================================================= + +/** handles activation (loading) of a UNO component. + @see com::sun::star::registry::XImplementationRegistration + */ +published interface XImplementationLoader: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + /** activates a concrete implementation within a component. + @param implementationName The name of the implementation, + which shall be instantiated. The method + <member>XImplementationLoader::writeRegistryInfo</member> + writes a list of implementation names hosted by this component. + @param implementationLoaderUrl specification bug, ignore this parameter, please + pass an empty string. + @param locationUrl Points to the location of the file containing + the component (for instance a .jar-file or a shared library). + This parameter + should be in an URL format (= protocol:protocol-dependent-part). + In case the string contains no + leading "protocol:", the implementation in general assumes, + that it is a relative file url. <p>Special loaders may define + their own protocol (for instance an executable loader may need + more than only one file url). + + @param xKey A registry which may be used to read static data previously + written via <method>XImplementationLoader::writeRegistryInfo()</method>. + The use of this parameter is deprecated. + + @return returns a factory interface, which allows to create an instance of + the concrete implementation. In general, the object supports a + <type scope="com::sun::star::lang">XSingleComponentFactory</type> + and the <type scope="com::sun::star::lang">XServiceInfo</type> interface. The + XServiceInfo interface informs about the capabilities of the + service implementation, not the factory itself. + */ + com::sun::star::uno::XInterface activate( [in] string implementationName, + [in] string implementationLoaderUrl, + [in] string locationUrl, + [in] com::sun::star::registry::XRegistryKey xKey ) + raises( com::sun::star::loader::CannotActivateFactoryException ); + + //------------------------------------------------------------------------- + /** writes a list of all implementations hosted by this component into a registry key. + <p>This method is called during registering a component. + @param xKey The registry key, which shall be used to write for each + implementation the implementation name plus a list of supported + services. + @param implementationLoaderUrl specification bug, ignore this parameter, please + pass an empty string. + @param locationUrl Points to the location of the file containing + the component (for instance a .jar-file or a shared library). + This parameter + should be in an URL format (= protocol:protocol-dependent-part). + In case the string contains no + leading "protocol:", the implementation in general assumes, + that it is a relative file url. <p>Special loaders may define + their own protocol (for instance an executable loader may need + more than only one file url). + @see com::sun::star::registry::XImplementationRegistration + */ + boolean writeRegistryInfo( [in] com::sun::star::registry::XRegistryKey xKey, + [in] string implementationLoaderUrl, + [in] string locationUrl ) + raises( com::sun::star::registry::CannotRegisterImplementationException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/loader/makefile.mk b/udkapi/com/sun/star/loader/makefile.mk new file mode 100644 index 000000000000..3f3641b0df34 --- /dev/null +++ b/udkapi/com/sun/star/loader/makefile.mk @@ -0,0 +1,51 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# This file is part of OpenOffice.org. +# +# OpenOffice.org is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License version 3 +# only, as published by the Free Software Foundation. +# +# OpenOffice.org is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License version 3 for more details +# (a copy is included in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU Lesser General Public License +# version 3 along with OpenOffice.org. If not, see +# <http://www.openoffice.org/license.html> +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=api + +TARGET=cssloader +PACKAGE=com$/sun$/star$/loader + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + CannotActivateFactoryException.idl\ + Java.idl\ + Java2.idl\ + Dynamic.idl\ + SharedLibrary.idl\ + XImplementationLoader.idl\ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |