Package io.jenkins.blueocean.service.embedded.rest

Class OrganizationImpl

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BlueOrganization

io.jenkins.blueocean.rest.factory.organization.AbstractOrganization

io.jenkins.blueocean.service.embedded.rest.OrganizationImpl

All Implemented Interfaces:

io.jenkins.blueocean.rest.Reachable, io.jenkins.blueocean.Routable

public class OrganizationImpl
extends io.jenkins.blueocean.rest.factory.organization.AbstractOrganization

BlueOrganization implementation for the embedded use.

Author:

Vivek Pandey, Kohsuke Kawaguchi

Field Summary

Fields inherited from class io.jenkins.blueocean.rest.model.BlueOrganization

DISPLAY_NAME, NAME, PIPELINES

Constructor Summary

Constructors

Constructor	Description
OrganizationImpl(String name, ModifiableTopLevelItemGroup group)

Method Summary

Modifier and Type	Method	Description
void	delete()
String	getDisplayName()
Object	getDynamic(String route)	Give plugins chance to handle this API route.
ModifiableTopLevelItemGroup	getGroup()
io.jenkins.blueocean.rest.hal.Link	getLink()
String	getName()	In embedded mode, there's only one organization
io.jenkins.blueocean.rest.model.BluePipelineContainer	getPipelines()
io.jenkins.blueocean.rest.model.BlueUser	getUser()
io.jenkins.blueocean.rest.model.BlueUserContainer	getUsers()	In the embedded case, there's only one organization and everyone belongs there, so we can just return that singleton.

Methods inherited from class io.jenkins.blueocean.rest.model.BlueOrganization

getUrlName

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationImpl

public OrganizationImpl(String name,
                        ModifiableTopLevelItemGroup group)

Method Detail

getName

public String getName()

In embedded mode, there's only one organization

Specified by:

getName in class io.jenkins.blueocean.rest.model.BlueOrganization

getGroup

@NonNull
public ModifiableTopLevelItemGroup getGroup()

Specified by:

getGroup in class io.jenkins.blueocean.rest.factory.organization.AbstractOrganization

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class io.jenkins.blueocean.rest.model.BlueOrganization

getPipelines

public io.jenkins.blueocean.rest.model.BluePipelineContainer getPipelines()

Specified by:

getPipelines in class io.jenkins.blueocean.rest.model.BlueOrganization

delete

@WebMethod(name="")
@DELETE
public void delete()

getUsers

public io.jenkins.blueocean.rest.model.BlueUserContainer getUsers()

In the embedded case, there's only one organization and everyone belongs there, so we can just return that singleton.

Specified by:

getUsers in class io.jenkins.blueocean.rest.model.BlueOrganization

getUser

public io.jenkins.blueocean.rest.model.BlueUser getUser()

Specified by:

getUser in class io.jenkins.blueocean.rest.model.BlueOrganization

getLink

public io.jenkins.blueocean.rest.hal.Link getLink()

getDynamic

public Object getDynamic(String route)

Give plugins chance to handle this API route.

Parameters:

route - URL path that needs handling. e.g. for requested url /rest/organizations/:id/xyz, route param value will be 'xyz'

Returns:

stapler object that can handle give route. Could be null