net.thevpc.nuts.boot.internal.util

Class NBootPlatformHome

java.lang.Object

net.thevpc.nuts.boot.internal.util.NBootPlatformHome

public class NBootPlatformHome
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static NBootPlatformHome	SYSTEM
static NBootPlatformHome	USER

Constructor Summary

Constructors

Constructor and Description
NBootPlatformHome(String platformOsFamily, boolean system, Function<String,String> env, Function<String,String> props)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	buildLocations(String storeStrategy, Map<String,String> baseLocations, Map<NBootHomeLocation,String> homeLocations, String workspaceLocation)
static String	currentOsFamily()
String	getCustomPlatformHomeFolder(String storeType, Map<NBootHomeLocation,String> homeLocations) resolves custom nuts home folder from homeLocations.
String	getHome()
String	getStore(String storeType)
String	getWindowsProgramFiles()
String	getWindowsProgramFilesX86()
String	getWindowsSystemDrive()
String	getWindowsSystemRoot()
String	getWorkspaceLocation(String workspaceName)
String	getWorkspaceLocation(String location, Map<NBootHomeLocation,String> homeLocations, String workspaceName) resolves nuts home folder.Home folder is the root for nuts folders.It depends on folder type and store layout.
String	getWorkspaceStore(String storeType, String workspaceName) resolves nuts home folder.Home folder is the root for nuts folders.It depends on folder type and store layout.
static NBootPlatformHome	of(String platformOsFamily)
static NBootPlatformHome	of(String platformOsFamily, boolean system)
static NBootPlatformHome	of(String platformOsFamily, Function<String,String> env, Function<String,String> props)
static NBootPlatformHome	ofPortable(String platformOsFamily, boolean system, Function<String,String> env, Function<String,String> props)
static NBootPlatformHome	ofPortable(String platformOsFamily, boolean system, String userName)
static NBootPlatformHome	ofPortable(String platformOsFamily, String userName)
static NBootPlatformHome	ofPortableSystem(String platformOsFamily, String userName)
static NBootPlatformHome	ofSystem(String platformOsFamily)
static NBootPlatformHome	ofSystem(String platformOsFamily, Function<String,String> env, Function<String,String> props)
static String[]	osFamilies()
static String	parseOsFamily(String value)
static String[]	storeTypes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER

public static final NBootPlatformHome USER

SYSTEM

public static final NBootPlatformHome SYSTEM

Constructor Detail

NBootPlatformHome

public NBootPlatformHome(String platformOsFamily,
                         boolean system,
                         Function<String,String> env,
                         Function<String,String> props)

Method Detail

ofSystem

public static NBootPlatformHome ofSystem(String platformOsFamily,
                                         Function<String,String> env,
                                         Function<String,String> props)

of

public static NBootPlatformHome of(String platformOsFamily,
                                   Function<String,String> env,
                                   Function<String,String> props)

ofSystem

public static NBootPlatformHome ofSystem(String platformOsFamily)

of

public static NBootPlatformHome of(String platformOsFamily)

of

public static NBootPlatformHome of(String platformOsFamily,
                                   boolean system)

ofPortable

public static NBootPlatformHome ofPortable(String platformOsFamily,
                                           String userName)

ofPortableSystem

public static NBootPlatformHome ofPortableSystem(String platformOsFamily,
                                                 String userName)

ofPortable

public static NBootPlatformHome ofPortable(String platformOsFamily,
                                           boolean system,
                                           String userName)

ofPortable

public static NBootPlatformHome ofPortable(String platformOsFamily,
                                           boolean system,
                                           Function<String,String> env,
                                           Function<String,String> props)

getCustomPlatformHomeFolder

public String getCustomPlatformHomeFolder(String storeType,
                                          Map<NBootHomeLocation,String> homeLocations)

resolves custom nuts home folder from homeLocations. Home folder is the root for nuts folders. It depends on folder type and store layout.

Parameters:

storeType - folder type to resolve home for

homeLocations - workspace home locations

Returns:

home folder path or null

getWorkspaceLocation

public String getWorkspaceLocation(String location,
                                   Map<NBootHomeLocation,String> homeLocations,
                                   String workspaceName)

resolves nuts home folder.Home folder is the root for nuts folders.It depends on folder type and store layout. For instance log folder depends on on the underlying operating system (linux,windows,...). Specifications: XDG Base Directory Specification (https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)

Parameters:

location - folder type to resolve home for

homeLocations - workspace home locations

workspaceName - workspace name or id (discriminator)

Returns:

home folder path TODO : rename me

getWorkspaceLocation

public String getWorkspaceLocation(String workspaceName)

getHome

public String getHome()

getWorkspaceStore

public String getWorkspaceStore(String storeType,
                                String workspaceName)

resolves nuts home folder.Home folder is the root for nuts folders.It depends on folder type and store layout. For instance log folder depends on on the underlying operating system (linux,windows,...). Specifications: XDG Base Directory Specification (https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)

Parameters:

storeType - folder type to resolve home for

workspaceName - workspace name or id (discriminator)

Returns:

home folder path

currentOsFamily

public static String currentOsFamily()

parseOsFamily

public static String parseOsFamily(String value)

getStore

public String getStore(String storeType)

getWindowsProgramFiles

public String getWindowsProgramFiles()

getWindowsProgramFilesX86

public String getWindowsProgramFilesX86()

getWindowsSystemRoot

public String getWindowsSystemRoot()

getWindowsSystemDrive

public String getWindowsSystemDrive()

osFamilies

public static String[] osFamilies()

storeTypes

public static String[] storeTypes()

buildLocations

public Map<String,String> buildLocations(String storeStrategy,
                                         Map<String,String> baseLocations,
                                         Map<NBootHomeLocation,String> homeLocations,
                                         String workspaceLocation)

Parameters:

storeStrategy - storeStrategy or null

baseLocations - baseLocations or null

homeLocations - homeLocations or null

workspaceLocation - workspaceName or null

Returns:

locations map