Branch data Line data Source code
1 : : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : : /*************************************************************************
3 : : *
4 : : * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 : : *
6 : : * Copyright 2000, 2010 Oracle and/or its affiliates.
7 : : *
8 : : * OpenOffice.org - a multi-platform office productivity suite
9 : : *
10 : : * This file is part of OpenOffice.org.
11 : : *
12 : : * OpenOffice.org is free software: you can redistribute it and/or modify
13 : : * it under the terms of the GNU Lesser General Public License version 3
14 : : * only, as published by the Free Software Foundation.
15 : : *
16 : : * OpenOffice.org is distributed in the hope that it will be useful,
17 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 : : * GNU Lesser General Public License version 3 for more details
20 : : * (a copy is included in the LICENSE file that accompanied this code).
21 : : *
22 : : * You should have received a copy of the GNU Lesser General Public License
23 : : * version 3 along with OpenOffice.org. If not, see
24 : : * <http://www.openoffice.org/license.html>
25 : : * for a copy of the LGPLv3 License.
26 : : *
27 : : ************************************************************************/
28 : : #ifndef _CPPUHELPER_ACCESS_CONTROL_HXX_
29 : : #define _CPPUHELPER_ACCESS_CONTROL_HXX_
30 : :
31 : : #include <com/sun/star/uno/XComponentContext.hpp>
32 : : #include <com/sun/star/security/XAccessController.hpp>
33 : : #include "cppuhelperdllapi.h"
34 : :
35 : :
36 : : namespace cppu
37 : : {
38 : :
39 : : /** Helper class retriving access controller singleton from component context.
40 : : */
41 : 0 : class CPPUHELPER_DLLPUBLIC AccessControl
42 : : {
43 : : ::com::sun::star::uno::Reference< ::com::sun::star::security::XAccessController > m_xController;
44 : :
45 : : public:
46 : : /** Ctor.
47 : :
48 : : @param xContext component context to retrieve access controller singleton
49 : : */
50 : : AccessControl(
51 : : ::com::sun::star::uno::Reference<
52 : : ::com::sun::star::uno::XComponentContext > const & xContext )
53 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
54 : : /** Ctor.
55 : :
56 : : @param xController access controller
57 : : */
58 : : AccessControl(
59 : : ::com::sun::star::uno::Reference<
60 : : ::com::sun::star::security::XAccessController > const & xController )
61 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
62 : : /** Copy ctor.
63 : :
64 : : @param ac another object
65 : : */
66 : : AccessControl( ::cppu::AccessControl const & ac )
67 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
68 : :
69 : : /** Clears the access controller reference being used.
70 : : */
71 : : inline void SAL_CALL clear() SAL_THROW(())
72 : : { m_xController.clear(); }
73 : :
74 : : /** Returns access to the access controller reference being used.
75 : :
76 : : @return access controller
77 : : */
78 : : inline ::com::sun::star::uno::Reference<
79 : : ::com::sun::star::security::XAccessController > const & SAL_CALL get() const SAL_THROW(())
80 : : { return m_xController; }
81 : :
82 : : /** Returns access to the access controller reference being used.
83 : :
84 : : @return access controller
85 : : */
86 : : inline ::com::sun::star::security::XAccessController * SAL_CALL operator -> () const SAL_THROW(())
87 : : { return m_xController.get(); }
88 : :
89 : :
90 : : /** A com.sun.star.security.RuntimePermission is for runtime permissions.
91 : : A RuntimePermission contains a name (also referred to as a "target name") but no
92 : : actions list; you either have the named permission or you don't.
93 : :
94 : : @param name name of permission
95 : : */
96 : : void SAL_CALL checkRuntimePermission(
97 : : ::rtl::OUString const & name )
98 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
99 : :
100 : : /** A com.sun.star.io.FilePermission represents access to a file or directory.
101 : : A FilePermission consists of a file url and a set of actions valid for that pathname.
102 : :
103 : : @param url file url
104 : : @param actions actions list
105 : : */
106 : : void SAL_CALL checkFilePermission(
107 : : ::rtl::OUString const & url,
108 : : ::rtl::OUString const & actions )
109 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
110 : :
111 : : /** A com.sun.star.connection.SocketPermission represents access to a network via sockets.
112 : : A SocketPermission consists of a host specification and a set of "actions"
113 : : specifying ways to connect to that host.
114 : :
115 : : @param host host and optional portrange
116 : : @param actions actions list
117 : : */
118 : : void SAL_CALL checkSocketPermission(
119 : : ::rtl::OUString const & host,
120 : : ::rtl::OUString const & actions )
121 : : SAL_THROW( (::com::sun::star::uno::RuntimeException) );
122 : : };
123 : :
124 : : }
125 : :
126 : : #endif
127 : :
128 : : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|