NetPhantomStarter (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Panel
    - - NetPhantomStarter

All Implemented Interfaces:: com.netphantom.starter.IDesktop, ActionListener, KeyListener, MouseListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AuthCB

Direct Known Subclasses:: NetPhantomStarterSSL

public class NetPhantomStarter
extends Panel
implements ActionListener, WindowListener, KeyListener, MouseListener, AuthCB, com.netphantom.starter.IDesktop

The program to launch the client after checking of newer available versions on the server. This program can also update itself prior to the launch, unless NetPhantom Starter on the Server is of a version less than 8.

NetPhantom Starter File Format (.nps)

NetPhantom applications can be launched by double-clicking a .nps file on Windows, macOS, or Linux (GNOME/KDE Plasma). The .nps file is an XML document with the following structure:

XML Structure


 <?xml version="1.0" encoding="UTF-8"?>
 <NetPhantomStarterLinks xml:space="preserve" version="8.0">
   <Link title="My Application"
         destination="https://server.example.com/app"
         pin="true"
         shortcutDir="C:/Users/user/Desktop"
         iconFile="my-icon.ico"
         jvmOptions="-Xmx512m -Dfoo=bar"
         classPath="lib/extra.jar:lib/util.jar"
         className="com.example.MyClass"
         removeScript="unpin-my-app.bat">
     <Arguments>
       <Arg>[netphantom-client-arg...1]</Arg>
       <Arg>[netphantom-client-arg...2]</Arg>
       <Arg>[netphantom-client-arg...3]</Arg>
       <Arg>...etc...</Arg>
     </Arguments>
     <IconFileInfo UTC-time="2026-01-03T12:00:00Z"
                   timestamp="1735905600000"
                   size="4286"
                   crc32="1234567890"/>
   </Link>
 </NetPhantomStarterLinks>

Root Element: `<NetPhantomStarterLinks>`

xml:space="preserve" - Preserves whitespace in the document.
version - The XML format version (currently "8.0").

Link Element: `<Link>`

Each <Link> element defines a NetPhantom application shortcut or taskbar/dock pin:

Attribute	Required	Description
`title`	Yes	Display name of the shortcut or pin.
`destination`	No	Server URL or destination specification for the application.
`pin`	No	Set to "true" for taskbar/dock pin; omitted for desktop/folder shortcuts.
`shortcutDir`	No*	Directory path for shortcut placement (omitted when `pin="true"`).
`iconFile`	Yes	Icon filename, relative to the icons folder (e.g., "my-app.ico").
`jvmOptions`	No	Space-separated JVM options (e.g., "-Xmx512m -Dfoo=bar").
`classPath`	No	Additional classpath entries (":" or ";" separated).
`className`	No	Fully qualified class name to execute.
`removeScript`	Yes	Undo/remove script filename, relative to the links folder.

Child Element: `<Arguments>`

Optional container for program arguments. Contains zero or more <Arg> child elements, each holding a single command-line argument as text content:


 <Arguments>
   <Arg>--verbose</Arg>
   <Arg>--config=prod.xml</Arg>
 </Arguments>

Child Element: `<IconFileInfo>`

Optional metadata about the icon file for validation purposes:

Attribute	Description
`UTC-time`	Human-readable UTC timestamp (ISO-8601 format).
`timestamp`	File last-modified time in epoch milliseconds.
`size`	File size in bytes.
`crc32`	CRC32 checksum of the file (optional).

File Storage Locations

Links XML: {user.home}/{user.name}/.NetPhantom8/links/np-links.xml
Icon files: {user.home}/{user.name}/.NetPhantom8/icons/
Undo scripts: {user.home}/{user.name}/.NetPhantom8/links/

Platform Support

Platform	Shortcut Type	Implementation
Windows	.lnk files, Taskbar pins	Shortcut-and-Pin.exe (x64/ARM64)
macOS	Dock pins, Folder aliases	Create-Shortcut.zsh script
Linux (GNOME)	.desktop files	gnome-Create-Shortcut.sh script
Linux (KDE Plasma)	.desktop files	kde-plasma-Create-Shortcut.sh script

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Panel
  Panel.AccessibleAWTPanel
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary
- Fields inherited from class java.awt.Component
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

NetPhantomStarter()

Constructors
Constructor and Description
`NetPhantomStarter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Performs action requested by the selection of a push button.
`boolean`	`confirmQuit()` Confirm the quitting of the application for macOS.
`String[]`	`getAuth(boolean usesSSL, boolean isProxy, String serverName, String scheme, String realm, String resource, String userID, String password)` Requests a password.
`boolean`	`hasPreferencesDialog()` Has preferences dialog for macOS?
`void`	`keyPressed(KeyEvent e)`
`void`	`keyReleased(KeyEvent e)`
`void`	`keyTyped(KeyEvent e)`
`static void`	`main(String[] arg)` This method starts execution of the Starter.
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`paint(Graphics g)`
`void`	`showAboutDialog()` Show the about dialog, called from AWT.
`void`	`windowActivated(WindowEvent e)`
`void`	`windowClosed(WindowEvent e)`
`void`	`windowClosing(WindowEvent e)` Window is closed.
`void`	`windowDeactivated(WindowEvent e)`
`void`	`windowDeiconified(WindowEvent e)`
`void`	`windowIconified(WindowEvent e)`
`void`	`windowOpened(WindowEvent e)`

Methods inherited from class java.awt.Panel
addNotify, getAccessibleContext

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Methods inherited from interface com.netphantom.starter.IDesktop
initDesktopJava9, showPreferencesDialog

- Constructor Detail
  - NetPhantomStarter
```
public NetPhantomStarter()
```
- Method Detail
  - main
```
public static void main(String[] arg)
```
    This method starts execution of the Starter.
    The program can be started with optional parameters, some of which consists of a switch followed by one or more values. The switch must be preceded by a '-' (dash) or a '/' (forward slash). The switch can be given in upper or lower case.
    The following parameters are accepted:
```
   baseURL
   -C startClass
   -A arg1 [arg2 [argN]]
 
```
    where:
    - baseURL is the URL to the local properties file.
    - strartClass means the class to be started by the starter. This will normally be se.entra.phantom.client.Phantom.
    - The argX parameters are any parameters to be passed on to the startClass.
    Parameters:
    
    arg - Any command line parameters.
  - paint
```
public void paint(Graphics g)
```
    Overrides:
    
    paint in class Container
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Performs action requested by the selection of a push button.
    
    Specified by:
    
    actionPerformed in interface ActionListener
    
    Parameters:
    
    e - The action event.
  - windowClosing
```
public void windowClosing(WindowEvent e)
```
    Window is closed.
    
    Specified by:
    
    windowClosing in interface WindowListener
  - windowOpened
```
public void windowOpened(WindowEvent e)
```
    Specified by:
    
    windowOpened in interface WindowListener
  - windowClosed
```
public void windowClosed(WindowEvent e)
```
    Specified by:
    
    windowClosed in interface WindowListener
  - windowActivated
```
public void windowActivated(WindowEvent e)
```
    Specified by:
    
    windowActivated in interface WindowListener
  - windowDeactivated
```
public void windowDeactivated(WindowEvent e)
```
    Specified by:
    
    windowDeactivated in interface WindowListener
  - windowIconified
```
public void windowIconified(WindowEvent e)
```
    Specified by:
    
    windowIconified in interface WindowListener
  - windowDeiconified
```
public void windowDeiconified(WindowEvent e)
```
    Specified by:
    
    windowDeiconified in interface WindowListener
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Specified by:
    
    keyTyped in interface KeyListener
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Specified by:
    
    keyPressed in interface KeyListener
  - keyReleased
```
public void keyReleased(KeyEvent e)
```
    Specified by:
    
    keyReleased in interface KeyListener
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface MouseListener
  - getAuth
```
public String[] getAuth(boolean usesSSL,
                        boolean isProxy,
                        String serverName,
                        String scheme,
                        String realm,
                        String resource,
                        String userID,
                        String password)
```
    Requests a password.
    The following parameters indicates how the process is handled:
    - Certificate:
      server = null, realm = null, resource = certificateFileName
    - Basic authentication:
      server = protocol://serverName[:port], realm = null, resource = null
    - Digest authentication:
      server = protocol://serverName[:port], realm = realmString, resource = null
    The parameters "userID" and "password" are set to null if no previous data is present, otherwise the previous userID (always null for certificate files) and the previous password.
    Specified by:
    
    getAuth in interface AuthCB
    
    Returns:
    
    null no userID/password is specified (cancel was pressed. String [2] String[0]=userID, String[1]=password, for certificate files, userID is null.
  - showAboutDialog
```
public void showAboutDialog()
```
    Show the about dialog, called from AWT.
    
    Specified by:
    
    showAboutDialog in interface com.netphantom.starter.IDesktop
  - confirmQuit
```
public boolean confirmQuit()
```
    Confirm the quitting of the application for macOS.
    
    Specified by:
    
    confirmQuit in interface com.netphantom.starter.IDesktop
    
    Returns:
    
    true if the quitting is allowed, false otherwise.
  - hasPreferencesDialog
```
public boolean hasPreferencesDialog()
```
    Has preferences dialog for macOS?
    
    Specified by:
    
    hasPreferencesDialog in interface com.netphantom.starter.IDesktop
    
    Returns:
    
    true if the preferences dialog is available, false otherwise.

Class NetPhantomStarter

NetPhantom Starter File Format (.nps)

XML Structure

Root Element: <NetPhantomStarterLinks>

Link Element: <Link>

Child Element: <Arguments>

Child Element: <IconFileInfo>

File Storage Locations

Platform Support

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Panel

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Panel

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.netphantom.starter.IDesktop

Constructor Detail

NetPhantomStarter

Method Detail

main

paint

actionPerformed

windowClosing

windowOpened

windowClosed

windowActivated

windowDeactivated

windowIconified

windowDeiconified

keyTyped

keyPressed

keyReleased

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

getAuth

showAboutDialog

confirmQuit

hasPreferencesDialog

Root Element: `<NetPhantomStarterLinks>`

Link Element: `<Link>`

Child Element: `<Arguments>`

Child Element: `<IconFileInfo>`