Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 : #ifndef INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
20 : #define INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
21 :
22 : #include <com/sun/star/uno/XComponentContext.hpp>
23 : #include <com/sun/star/security/XAccessController.hpp>
24 : #include <cppuhelper/cppuhelperdllapi.h>
25 :
26 :
27 : namespace cppu
28 : {
29 :
30 : /** Helper class retriving access controller singleton from component context.
31 : */
32 1 : class CPPUHELPER_DLLPUBLIC AccessControl
33 : {
34 : ::com::sun::star::uno::Reference< ::com::sun::star::security::XAccessController > m_xController;
35 :
36 : public:
37 : /** Ctor.
38 :
39 : @param xContext component context to retrieve access controller singleton
40 : */
41 : AccessControl(
42 : ::com::sun::star::uno::Reference<
43 : ::com::sun::star::uno::XComponentContext > const & xContext );
44 : /** Ctor.
45 :
46 : @param xController access controller
47 : */
48 : AccessControl(
49 : ::com::sun::star::uno::Reference<
50 : ::com::sun::star::security::XAccessController > const & xController );
51 : /** Copy ctor.
52 :
53 : @param ac another object
54 : */
55 : AccessControl( ::cppu::AccessControl const & ac );
56 :
57 : /** Clears the access controller reference being used.
58 : */
59 : inline void SAL_CALL clear()
60 : { m_xController.clear(); }
61 :
62 : /** Returns access to the access controller reference being used.
63 :
64 : @return access controller
65 : */
66 : inline ::com::sun::star::uno::Reference<
67 : ::com::sun::star::security::XAccessController > const & SAL_CALL get() const
68 : { return m_xController; }
69 :
70 : /** Returns access to the access controller reference being used.
71 :
72 : @return access controller
73 : */
74 : inline ::com::sun::star::security::XAccessController * SAL_CALL operator -> () const
75 : { return m_xController.get(); }
76 :
77 :
78 : /** A com.sun.star.security.RuntimePermission is for runtime permissions.
79 : A RuntimePermission contains a name (also referred to as a "target name") but no
80 : actions list; you either have the named permission or you don't.
81 :
82 : @param name name of permission
83 : */
84 : void SAL_CALL checkRuntimePermission(
85 : ::rtl::OUString const & name );
86 :
87 : /** A com.sun.star.io.FilePermission represents access to a file or directory.
88 : A FilePermission consists of a file url and a set of actions valid for that pathname.
89 :
90 : @param url file url
91 : @param actions actions list
92 : */
93 : void SAL_CALL checkFilePermission(
94 : ::rtl::OUString const & url,
95 : ::rtl::OUString const & actions );
96 :
97 : /** A com.sun.star.connection.SocketPermission represents access to a network via sockets.
98 : A SocketPermission consists of a host specification and a set of "actions"
99 : specifying ways to connect to that host.
100 :
101 : @param host host and optional portrange
102 : @param actions actions list
103 : */
104 : void SAL_CALL checkSocketPermission(
105 : ::rtl::OUString const & host,
106 : ::rtl::OUString const & actions );
107 : };
108 :
109 : }
110 :
111 : #endif
112 :
113 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
