## org.mortbay.setuid
Class SetUIDServer

    java.lang.Object
      org.mortbay.component.AbstractLifeCycle
          org.mortbay.jetty.handler.AbstractHandler
              org.mortbay.jetty.handler.AbstractHandlerContainer
                  org.mortbay.jetty.handler.HandlerWrapper
                      org.mortbay.jetty.Server
                          org.mortbay.setuid.SetUIDServer

All Implemented Interfaces:
  LifeCycle, Handler, HandlerContainer, Attributes

    public class SetUIDServer

extends Server

This extension of `Server` will make a JNI call to set the unix UID. This can be used to start the server as root so that privileged ports may be accessed and then switch to a non-root user for security. Depending on the value of `setStartServerAsPrivileged(boolean)`, either the server will be started and then the UID set; or the `Server.getConnectors()` will be opened with a call to `Connector.open()`, the UID set and then the server is started. The later is the default and avoids any webapplication code being run as a privileged user, but will not work if the application code also needs to open privileged ports.

The configured umask is set before the server is started and the configured uid is set after the server is started.

Author:
  gregw

Nested Class Summary

Nested classes/interfaces inherited from class org.mortbay.jetty.Server
`Server.Graceful`

Field Summary

Fields inherited from class org.mortbay.jetty.handler.AbstractHandler
`_string`

Fields inherited from interface org.mortbay.jetty.Handler
`ALL, DEFAULT, ERROR, FORWARD, INCLUDE, REQUEST`

Constructor Summary
`SetUIDServer()`

Method Summary
`protected void` `doStart()`
`int` `getGid()`
`String` `getGroupname()`
`int` `getUid()`
`int` `getUmask()`
`String` `getUsername()`
`boolean` `isStartServerAsPrivileged()`
`void` `setGid(int gid)`
`void` `setGroupname(String groupname)`
`void` `setStartServerAsPrivileged(boolean startContextsAsPrivileged)`
`void` `setUid(int uid)`
`void` `setUmask(int umask)`
`void` `setUsername(String username)`

Methods inherited from class org.mortbay.jetty.Server

`addConnector, addHandler, addLifeCycle, addUserRealm, clearAttributes, doStop, getAttribute, getAttributeNames, getConnectors, getContainer, getGracefulShutdown, getHandlers, getSendDateHeader, getSendServerVersion, getSessionIdManager, getStopAtShutdown, getThreadPool, getUserRealms, getVersion, handle, join, removeAttribute, removeConnector, removeHandler, removeLifeCycle, removeUserRealm, setAttribute, setConnectors, setGracefulShutdown, setHandlers, setSendDateHeader, setSendServerVersion, setSessionIdManager, setStopAtShutdown, setThreadPool, setUserRealms`

Methods inherited from class org.mortbay.jetty.handler.HandlerWrapper
`expandChildren, getHandler, handle, setHandler, setServer`

Methods inherited from class org.mortbay.jetty.handler.AbstractHandlerContainer
`expandHandler, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass`

Methods inherited from class org.mortbay.jetty.handler.AbstractHandler
`destroy, getServer, toString`

Methods inherited from class org.mortbay.component.AbstractLifeCycle
`isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.mortbay.component.LifeCycle
`isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop`

Constructor Detail

### SetUIDServer

    public SetUIDServer()

Method Detail

### setUsername

    public void setUsername(String username)

### getUsername

    public String getUsername()

### setGroupname

    public void setGroupname(String groupname)

### getGroupname

    public String getGroupname()

### getUmask

    public int getUmask()

### setUmask

    public void setUmask(int umask)

### getUid

    public int getUid()

### setUid

    public void setUid(int uid)

### setGid

    public void setGid(int gid)

### getGid

    public int getGid()

### doStart

    protected void doStart()
                    throws Exception

  Overrides:
    `doStart` in class `Server`
  Throws:
    `Exception`

### isStartServerAsPrivileged

    public boolean isStartServerAsPrivileged()

  Returns:
    the startServerAsPrivileged

### setStartServerAsPrivileged

    public void setStartServerAsPrivileged(boolean startContextsAsPrivileged)

  Parameters:
    `startServerAsPrivileged` - if true, the server is started and then the process UID is switched. If false, the connectors are opened, the UID is switched and then the server is started.
  See Also:
    `Connector#open()}`

Copyright © 2007 Mort Bay Consulting. All Rights Reserved.