blob: 68835a8c5b6ede448fa50cf81a00e32666edfca6 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*******************************************************************************
* Copyright (c) 2003, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.osgi.service.environment;
/**
* A Framework service which gives access to the command line used to start
* this running framework as well as information about the environment
* such as the current operating system, machine architecture, locale and
* windowing system.
* <p>
* This interface is not intended to be implemented by clients.
* </p>
*
* @since 3.0
* @noimplement This interface is not intended to be implemented by clients.
*/
// TODO Need to add a method that gets the real application args.
//We might also want to explain how the command line is organized: fwk / non fwk. Non-fwk is rt args and app args.
public interface EnvironmentInfo {
/**
* Returns all command line arguments specified when the running framework was started.
*
* @return the array of command line arguments.
*/
public String[] getCommandLineArgs();
/**
* Returns the arguments consumed by the framework implementation itself. Which
* arguments are consumed is implementation specific.
*
* @return the array of command line arguments consumed by the framework.
*/
public String[] getFrameworkArgs();
/**
* Returns the arguments not consumed by the framework implementation itself. Which
* arguments are consumed is implementation specific.
*
* @return the array of command line arguments not consumed by the framework.
*/
public String[] getNonFrameworkArgs();
/**
* Returns the string name of the current system architecture.
* The value is a user-defined string if the architecture is
* specified on the command line, otherwise it is the value
* returned by <code>java.lang.System.getProperty("os.arch")</code>.
*
* @return the string name of the current system architecture
*/
public String getOSArch();
/**
* Returns the string name of the current locale for use in finding files
* whose path starts with <code>$nl$</code>.
*
* @return the string name of the current locale
*/
public String getNL();
/**
* Returns the string name of the current operating system for use in finding
* files whose path starts with <code>$os$</code>. Return {@link Constants#OS_UNKNOWN}
* if the operating system cannot be determined.
* <p>
* The value may indicate one of the operating systems known to the platform
* (as specified in <code>org.eclipse.core.runtime.Platform#knownOSValues</code>)
* or a user-defined string if the operating system name is specified on the command line.
* </p>
*
* @return the string name of the current operating system
*/
public String getOS();
/**
* Returns the string name of the current window system for use in finding files
* whose path starts with <code>$ws$</code>. Return <code>null</code>
* if the window system cannot be determined.
*
* @return the string name of the current window system or <code>null</code>
*/
public String getWS();
/**
* Returns <code>true</code> if the framework is in debug mode and
* <code>false</code> otherwise.
*
* @return whether or not the framework is in debug mode
*/
public boolean inDebugMode();
/**
* Returns <code>true</code> if the framework is in development mode
* and <code>false</code> otherwise.
*
* @return whether or not the framework is in development mode
*/
public boolean inDevelopmentMode();
/**
* Returns the value for the specified property. Environment Properties are
* backed by the Java system properties. When the option
* <code>osgi.framework.useSystemProperties</code> is used then
* the environment properties are specific for each instance of the framework.
* <p>
* This method should be used instead of the <code>System.getProperty(String)</code>
* method to avoid the global nature of system properties.
* </p>
* @param key the property key
* @return the value of the property, or null
* @since 3.4
*/
public String getProperty(String key);
/**
* Sets the value for the specified property. Environment Properties are
* backed by the Java system properties. When the option
* <code>osgi.framework.useSystemProperties</code> is used then
* the environment properties are specific for each instance of the framework.
* <p>
* This method should be used instead of the <code>System.setProperty(String, String)</code>
* method to avoid the global nature of system properties.
* </p>
* @param key the property key
* @param value the value of the property
* @return the old value of the property, or null
* @since 3.4
*/
public String setProperty(String key, String value);
}
|
