blob: f76c09249500bdf6ba2a000ab20447b4e89d3988 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_66) on Fri Jan 15 14:33:43 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OsUtils (Apache Mina SSHD :: Core 1.1.0 API)</title>
<meta name="date" content="2016-01-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OsUtils (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OsUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/sshd/common/util/ObjectBuilder.html" title="interface in org.apache.sshd.common.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/common/util/Pair.html" title="class in org.apache.sshd.common.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/util/OsUtils.html" target="_top">Frames</a></li>
<li><a href="OsUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sshd.common.util</div>
<h2 title="Class OsUtils" class="title">Class OsUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sshd.common.util.OsUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">OsUtils</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Operating system dependent utility methods.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#CURRENT_USER_OVERRIDE_PROP">CURRENT_USER_OVERRIDE_PROP</a></span></code>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCurrentUser--"><code>getCurrentUser()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#JAVA_VERSION_OVERRIDE_PROP">JAVA_VERSION_OVERRIDE_PROP</a></span></code>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getJavaVersion--"><code>getJavaVersion()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#LINUX_COMMAND">LINUX_COMMAND</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#LINUX_SHELL_COMMAND_NAME">LINUX_SHELL_COMMAND_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#OS_TYPE_OVERRIDE_PROP">OS_TYPE_OVERRIDE_PROP</a></span></code>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--"><code>isWin32()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#ROOT_USER">ROOT_USER</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#WINDOWS_COMMAND">WINDOWS_COMMAND</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#WINDOWS_SHELL_COMMAND_NAME">WINDOWS_SHELL_COMMAND_NAME</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCanonicalUser-java.lang.String-">getCanonicalUser</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>
<div class="block">Remove <code>Windows</code> domain and/or group prefix as well as &quot;(User);&quot suffix</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getComparablePath-java.lang.String-">getComparablePath</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCurrentUser--">getCurrentUser</a></span>()</code>
<div class="block">Get current user name</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/sshd/common/util/VersionInfo.html" title="class in org.apache.sshd.common.util">VersionInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getJavaVersion--">getJavaVersion</a></span>()</code>
<div class="block">Resolves the reported Java version by consulting <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#JAVA_VERSION_OVERRIDE_PROP"><code>JAVA_VERSION_OVERRIDE_PROP</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isUNIX--">isUNIX</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--">isWin32</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#resolveCanonicalGroup-java.lang.String-java.lang.String-">resolveCanonicalGroup</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>
<div class="block">Attempts to resolve canonical group name for <code>Windows</code></div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#resolveDefaultInteractiveCommand--">resolveDefaultInteractiveCommand</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#resolveInteractiveCommand-boolean-">resolveInteractiveCommand</a></span>(boolean&nbsp;isWin32)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#setCurrentUser-java.lang.String-">setCurrentUser</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</code>
<div class="block">Can be used to programmatically set the username reported by <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCurrentUser--"><code>getCurrentUser()</code></a></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#setJavaVersion-org.apache.sshd.common.util.VersionInfo-">setJavaVersion</a></span>(<a href="../../../../../org/apache/sshd/common/util/VersionInfo.html" title="class in org.apache.sshd.common.util">VersionInfo</a>&nbsp;version)</code>
<div class="block">Set programmatically the reported Java version</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#setWin32-java.lang.Boolean-">setWin32</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;win32)</code>
<div class="block">Can be used to enforce Win32 or Linux report from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--"><code>isWin32()</code></a> or <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isUNIX--"><code>isUNIX()</code></a></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CURRENT_USER_OVERRIDE_PROP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CURRENT_USER_OVERRIDE_PROP</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CURRENT_USER_OVERRIDE_PROP</pre>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCurrentUser--"><code>getCurrentUser()</code></a>.
If not set then &quot;user.name&quot; system property is used</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.CURRENT_USER_OVERRIDE_PROP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="JAVA_VERSION_OVERRIDE_PROP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JAVA_VERSION_OVERRIDE_PROP</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> JAVA_VERSION_OVERRIDE_PROP</pre>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getJavaVersion--"><code>getJavaVersion()</code></a>.
If not set then &quot;java.version&quot; system property is used</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.JAVA_VERSION_OVERRIDE_PROP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OS_TYPE_OVERRIDE_PROP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OS_TYPE_OVERRIDE_PROP</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OS_TYPE_OVERRIDE_PROP</pre>
<div class="block">Property that can be used to override the reported value from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--"><code>isWin32()</code></a>.
If not set then &quot;os.name&quot; system property is used</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.OS_TYPE_OVERRIDE_PROP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WINDOWS_SHELL_COMMAND_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WINDOWS_SHELL_COMMAND_NAME</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WINDOWS_SHELL_COMMAND_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.WINDOWS_SHELL_COMMAND_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LINUX_SHELL_COMMAND_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINUX_SHELL_COMMAND_NAME</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LINUX_SHELL_COMMAND_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.LINUX_SHELL_COMMAND_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ROOT_USER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROOT_USER</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ROOT_USER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sshd.common.util.OsUtils.ROOT_USER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LINUX_COMMAND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINUX_COMMAND</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; LINUX_COMMAND</pre>
</li>
</ul>
<a name="WINDOWS_COMMAND">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WINDOWS_COMMAND</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; WINDOWS_COMMAND</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isUNIX--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUNIX</h4>
<pre>public static&nbsp;boolean&nbsp;isUNIX()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the host is a UNIX system (and not Windows).</dd>
</dl>
</li>
</ul>
<a name="isWin32--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWin32</h4>
<pre>public static&nbsp;boolean&nbsp;isWin32()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the host is Windows (and not UNIX).</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#OS_TYPE_OVERRIDE_PROP"><code>OS_TYPE_OVERRIDE_PROP</code></a>,
<a href="../../../../../org/apache/sshd/common/util/OsUtils.html#setWin32-java.lang.Boolean-"><code>setWin32(Boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setWin32-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWin32</h4>
<pre>public static&nbsp;void&nbsp;setWin32(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;win32)</pre>
<div class="block">Can be used to enforce Win32 or Linux report from <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--"><code>isWin32()</code></a> or <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isUNIX--"><code>isUNIX()</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>win32</code> - The value to set - if <code>null</code> then O/S type is auto-detected</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#isWin32--"><code>isWin32()</code></a></dd>
</dl>
</li>
</ul>
<a name="resolveDefaultInteractiveCommand--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveDefaultInteractiveCommand</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;resolveDefaultInteractiveCommand()</pre>
</li>
</ul>
<a name="resolveInteractiveCommand-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveInteractiveCommand</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;resolveInteractiveCommand(boolean&nbsp;isWin32)</pre>
</li>
</ul>
<a name="getCurrentUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentUser</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrentUser()</pre>
<div class="block">Get current user name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current user</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#CURRENT_USER_OVERRIDE_PROP"><code>CURRENT_USER_OVERRIDE_PROP</code></a></dd>
</dl>
</li>
</ul>
<a name="getCanonicalUser-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCanonicalUser</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCanonicalUser(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</pre>
<div class="block">Remove <code>Windows</code> domain and/or group prefix as well as &quot;(User);&quot suffix</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - The original username - ignored if <code>null</code>/empty</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The canonical user - unchanged if <code>Unix</code> O/S</dd>
</dl>
</li>
</ul>
<a name="resolveCanonicalGroup-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveCanonicalGroup</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resolveCanonicalGroup(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</pre>
<div class="block">Attempts to resolve canonical group name for <code>Windows</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>group</code> - The original group name - used if not <code>null</code>/empty</dd>
<dd><code>user</code> - The owner name - sometimes it contains a group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The canonical group name</dd>
</dl>
</li>
</ul>
<a name="setCurrentUser-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrentUser</h4>
<pre>public static&nbsp;void&nbsp;setCurrentUser(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</pre>
<div class="block">Can be used to programmatically set the username reported by <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#getCurrentUser--"><code>getCurrentUser()</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - The username to set - if <code>null</code> then <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#CURRENT_USER_OVERRIDE_PROP"><code>CURRENT_USER_OVERRIDE_PROP</code></a>
will be consulted</dd>
</dl>
</li>
</ul>
<a name="getJavaVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaVersion</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/sshd/common/util/VersionInfo.html" title="class in org.apache.sshd.common.util">VersionInfo</a>&nbsp;getJavaVersion()</pre>
<div class="block">Resolves the reported Java version by consulting <a href="../../../../../org/apache/sshd/common/util/OsUtils.html#JAVA_VERSION_OVERRIDE_PROP"><code>JAVA_VERSION_OVERRIDE_PROP</code></a>.
If not set, then &quot;java.version&quot; property is used</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The resolved <a href="../../../../../org/apache/sshd/common/util/VersionInfo.html" title="class in org.apache.sshd.common.util"><code>VersionInfo</code></a> - never <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/util/OsUtils.html#setJavaVersion-org.apache.sshd.common.util.VersionInfo-"><code>setJavaVersion(VersionInfo)</code></a></dd>
</dl>
</li>
</ul>
<a name="setJavaVersion-org.apache.sshd.common.util.VersionInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJavaVersion</h4>
<pre>public static&nbsp;void&nbsp;setJavaVersion(<a href="../../../../../org/apache/sshd/common/util/VersionInfo.html" title="class in org.apache.sshd.common.util">VersionInfo</a>&nbsp;version)</pre>
<div class="block">Set programmatically the reported Java version</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - The version - if <code>null</code> then it will be automatically resolved</dd>
</dl>
</li>
</ul>
<a name="getComparablePath-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getComparablePath</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getComparablePath(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - The original path</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A path that can be compared with another one where case
sensitivity of the underlying O/S has been taken into account -
never <code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OsUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/sshd/common/util/ObjectBuilder.html" title="interface in org.apache.sshd.common.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/common/util/Pair.html" title="class in org.apache.sshd.common.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/util/OsUtils.html" target="_top">Frames</a></li>
<li><a href="OsUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>